{"items":[{"type":"link","label":"VOL (On-Line Verifier) API","link":"/it/products/pki-on-prem/vol/openapi","routeSlug":"/it/products/pki-on-prem/vol/openapi","content":{"contentType":"overview","meta":{"name":"VOL (On-Line Verifier) API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/@l10n/it/products/pki-on-prem/VOL/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/@l10n/it/products/pki-on-prem/VOL/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com","description":"FQDN (or host:port) where VOL is deployed"}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"VOL (On-Line Verifier) API (1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OpenAPI specification generated from the provided VOL documentation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All endpoints are protected by token-based authentication via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: token <token-value>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base URL"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All paths below are relative to:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://{address}/api"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Caching"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploaded documents are kept in cache for a configurable time window. After expiry, the document"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is deleted and must be uploaded again."},"children":[]}]}]}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Documents","link":"/it/products/pki-on-prem/vol/openapi/documents","routeSlug":"/it/products/pki-on-prem/vol/openapi/documents","items":[{"label":"Upload document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/pki-on-prem/vol/openapi/documents/uploaddocument","routeSlug":"/it/products/pki-on-prem/vol/openapi/documents/uploaddocument","metadata":{"seo":{"title":"Upload document","description":"Upload a signed document to the system in order to run subsequent operations (signature report, verification, content extraction, etc.)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadDocument","name":"Upload document","isWebhook":false,"pointer":"/paths/~1documents~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload a signed document to the system in order to run subsequent operations (signature report, verification, content extraction, etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can upload:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a single signed file"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (embedded signature), or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"two separate files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the main document plus a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"detached signature"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verification_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fixes the verification date used by VOL; if omitted VOL chooses a date depending on the verification profile."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthToken","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token-based authentication header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: token 0540c6085962614ab245e07963d9aa68"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_0"}},"schemaId":"schema_0","pointer":"/paths/~1documents~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/documents/","servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthToken","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_0"}},"responseCodes":["201","400","401","502"],"pointer":"/documents/","href":"documents/uploaddocument","openApiOperationId":"uploadDocument","summary":"Upload document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com"}}}],"schemaId":"schema_0","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_0"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Document uploaded successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadDocumentResponse","exampleIds":["paths/~1documents~1/post/responses/201/content/application~1json/examples/ok"]}},"schemaId":"components/schemas/UploadDocumentResponse","exampleIds":["paths/~1documents~1/post/responses/201/content/application~1json/examples/ok"],"headers":{"location":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relative URL of the uploaded document (contains the unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"schema":{"type":"string","example":"/documents/e4d13719410fae2f"}}},"headerSchemaId":"schema_1"},{"code":"400","description":"Bad Request (multipart parsing / invalid boundary)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1/post/responses/400/content/application~1json/examples/invalidBoundary"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1/post/responses/400/content/application~1json/examples/invalidBoundary"]},{"code":"401","description":"Unauthorized (invalid or missing token)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1/post/responses/401/content/application~1json/examples/invalidToken"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1/post/responses/401/content/application~1json/examples/invalidToken"]},{"code":"502","description":"Upstream/service error (HTML body)","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_2"}},"schemaId":"schema_2"}],"pointer":"/paths/~1documents~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/UploadDocumentResponse","exampleIds":["paths/~1documents~1/post/responses/201/content/application~1json/examples/ok"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadDocumentResponse","exampleIds":["paths/~1documents~1/post/responses/201/content/application~1json/examples/ok"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1/post/responses/400/content/application~1json/examples/invalidBoundary"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1/post/responses/400/content/application~1json/examples/invalidBoundary"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1/post/responses/401/content/application~1json/examples/invalidToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1/post/responses/401/content/application~1json/examples/invalidToken"]}}},{"code":"502","schemaId":"schema_2","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_2"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/uploaddocument"}],"panels":[]}]},"httpPath":"/documents/"},{"label":"Get document","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/pki-on-prem/vol/openapi/documents/getdocument","routeSlug":"/it/products/pki-on-prem/vol/openapi/documents/getdocument","metadata":{"seo":{"title":"Get document","description":"Retrieve the originally uploaded document content.The returned content is exactly the same as the originally uploaded file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDocument","name":"Get document","isWebhook":false,"pointer":"/paths/~1documents~1{document-id}~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the originally uploaded document content."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The returned content is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the same as the originally uploaded file."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: On success, the server response does "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" include a filename header; the client must decide a filename."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthToken","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token-based authentication header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: token 0540c6085962614ab245e07963d9aa68"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"document-id","in":"path","schemaId":"schema_3","description":"Unique document identifier returned by upload (hexadecimal)","required":true,"example":"e4d13719410fae2f"}],"pointer":"/paths/~1documents~1{document-id}~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/documents/{document-id}/","servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com"}}}],"parameters":{"path":[{"name":"document-id","in":"path","required":true,"example":"e4d13719410fae2f","schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthToken","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/documents/{document-id}/","href":"documents/getdocument","openApiOperationId":"getDocument","summary":"Get document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Original document bytes","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_4"}},"schemaId":"schema_4"},{"code":"401","description":"Unauthorized (invalid or missing token)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1/get/responses/401/content/application~1json/examples/invalidToken"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1/get/responses/401/content/application~1json/examples/invalidToken"]},{"code":"404","description":"Resource not found (document expired/missing or wrong id)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1/get/responses/404/content/application~1json/examples/notFound"]}],"pointer":"/paths/~1documents~1{document-id}~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_4","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_4"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1/get/responses/401/content/application~1json/examples/invalidToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1/get/responses/401/content/application~1json/examples/invalidToken"]}}},{"code":"404","schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1/get/responses/404/content/application~1json/examples/notFound"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/getdocument"}],"panels":[]}]},"httpPath":"/documents/{document-id}/"},{"label":"Get signature structure","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/pki-on-prem/vol/openapi/documents/getsignaturereport","routeSlug":"/it/products/pki-on-prem/vol/openapi/documents/getsignaturereport","metadata":{"seo":{"title":"Get signature structure","description":"Get the signature structure affixed to the uploaded document (CAdES only) as a JSON report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSignatureReport","name":"Get signature structure","isWebhook":false,"pointer":"/paths/~1documents~1{document-id}~1report/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get signature structure","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the signature structure affixed to the uploaded document ("},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAdES only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as a JSON report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The returned object includes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": HTTP status as string (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"200 OK\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result.report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the signature structure"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result.errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": list of errors (empty array when none)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the schemas section for a practical, navigable structure (kept permissive because the report can be large and varies by signature)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthToken","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token-based authentication header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: token 0540c6085962614ab245e07963d9aa68"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"document-id","in":"path","schemaId":"schema_3","description":"Unique document identifier returned by upload (hexadecimal)","required":true,"example":"e4d13719410fae2f"}],"pointer":"/paths/~1documents~1{document-id}~1report/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/documents/{document-id}/report","servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com"}}}],"parameters":{"path":[{"name":"document-id","in":"path","required":true,"example":"e4d13719410fae2f","schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthToken","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","502"],"pointer":"/documents/{document-id}/report","href":"documents/getsignaturereport","openApiOperationId":"getSignatureReport","summary":"Get signature structure"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Signature structure report","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignatureReportEnvelope"}},"schemaId":"components/schemas/SignatureReportEnvelope"},{"code":"401","description":"Unauthorized (invalid or missing token)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1report/get/responses/401/content/application~1json/examples/invalidToken"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1report/get/responses/401/content/application~1json/examples/invalidToken"]},{"code":"404","description":"Resource not found (document expired/missing or wrong id)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1report/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1report/get/responses/404/content/application~1json/examples/notFound"]},{"code":"502","description":"Upstream/service error (HTML body)","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_2"}},"schemaId":"schema_2"}],"pointer":"/paths/~1documents~1{document-id}~1report/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SignatureReportEnvelope","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignatureReportEnvelope"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1report/get/responses/401/content/application~1json/examples/invalidToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1report/get/responses/401/content/application~1json/examples/invalidToken"]}}},{"code":"404","schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1report/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1report/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"502","schemaId":"schema_2","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_2"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/getsignaturereport"}],"panels":[]}]},"httpPath":"/documents/{document-id}/report"},{"label":"Get extracted content","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/pki-on-prem/vol/openapi/documents/getdocumentcontent","routeSlug":"/it/products/pki-on-prem/vol/openapi/documents/getdocumentcontent","metadata":{"seo":{"title":"Get extracted content","description":"Return the extracted (unsigned) content of a previously uploaded document."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDocumentContent","name":"Get extracted content","isWebhook":false,"pointer":"/paths/~1documents~1{document-id}~1content/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get extracted content","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return the extracted (unsigned) content of a previously uploaded document."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The returned bytes depend on the signature type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CAdES/XAdES"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": returns the original document "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"without"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the signature."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAdES"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": returns the uploaded signed PDF (as described by the documentation UI behavior)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dependency"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method must be invoked "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" running verification ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /documents/{document-id}/verify/report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"because VOL does not extract content until signature verification is performed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If invoked before verification, VOL returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502 Bad Gateway"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an HTML error page."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthToken","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token-based authentication header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: token 0540c6085962614ab245e07963d9aa68"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"document-id","in":"path","schemaId":"schema_3","description":"Unique document identifier returned by upload (hexadecimal)","required":true,"example":"e4d13719410fae2f"}],"pointer":"/paths/~1documents~1{document-id}~1content/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/documents/{document-id}/content","servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com"}}}],"parameters":{"path":[{"name":"document-id","in":"path","required":true,"example":"e4d13719410fae2f","schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthToken","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","404","502"],"pointer":"/documents/{document-id}/content","href":"documents/getdocumentcontent","openApiOperationId":"getDocumentContent","summary":"Get extracted content"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Extracted document content bytes","mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_4"}},"schemaId":"schema_4"},{"code":"401","description":"Unauthorized (invalid or missing token)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1content/get/responses/401/content/application~1json/examples/invalidToken"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1content/get/responses/401/content/application~1json/examples/invalidToken"]},{"code":"404","description":"Resource not found (document expired/missing or wrong id)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1content/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1content/get/responses/404/content/application~1json/examples/notFound"]},{"code":"502","description":"Upstream/service error (HTML body)","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_2"}},"schemaId":"schema_2"}],"pointer":"/paths/~1documents~1{document-id}~1content/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_4","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_4"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1content/get/responses/401/content/application~1json/examples/invalidToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1content/get/responses/401/content/application~1json/examples/invalidToken"]}}},{"code":"404","schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1content/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1content/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"502","schemaId":"schema_2","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_2"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/getdocumentcontent"}],"panels":[]}]},"httpPath":"/documents/{document-id}/content"},{"label":"Verify document and get report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/pki-on-prem/vol/openapi/documents/verifydocument","routeSlug":"/it/products/pki-on-prem/vol/openapi/documents/verifydocument","metadata":{"seo":{"title":"Verify document and get report","description":"Verify a previously uploaded document and return a verification report."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"verifyDocument","name":"Verify document and get report","isWebhook":false,"pointer":"/paths/~1documents~1{document-id}~1verify~1report/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify document and get report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify a previously uploaded document and return a verification report."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The output depends on query parameters:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"template=report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → JSON report"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=rml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"template=report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → PDF report encoded as "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"base64"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lang"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → ISO 3166-1 alpha-2 country codes to choose the language (defaults to system language)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The documentation examples show that if parameters are omitted, the service may return an HTML report;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this spec models the documented JSON/base64 outputs and also allows "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a fallback."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthToken","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token-based authentication header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: token 0540c6085962614ab245e07963d9aa68"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"document-id","in":"path","schemaId":"schema_3","description":"Unique document identifier returned by upload (hexadecimal)","required":true,"example":"e4d13719410fae2f"}],"pointer":"/paths/~1documents~1{document-id}~1verify~1report/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output type (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"json"},{"name":"template","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report template (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"report"},{"name":"lang","in":"query","schemaId":"schema_6","description":"Language code (ISO 3166-1 alpha-2)","example":"it"}],"pointer":"/paths/~1documents~1{document-id}~1verify~1report/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/documents/{document-id}/verify/report","servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com"}}}],"parameters":{"path":[{"name":"document-id","in":"path","required":true,"example":"e4d13719410fae2f","schemaId":"schema_3"}],"query":[{"name":"type","in":"query","required":false,"example":"json","schemaId":"schema_5"},{"name":"template","in":"query","required":false,"example":"report","schemaId":"schema_5"},{"name":"lang","in":"query","required":false,"example":"it","schemaId":"schema_6"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthToken","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","502"],"pointer":"/documents/{document-id}/verify/report","href":"documents/verifydocument","openApiOperationId":"verifyDocument","summary":"Verify document and get report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Verification report (JSON) or base64-encoded PDF (or HTML fallback)","mediaType":"application/json","mediaTypes":["application/json","text/plain","text/html"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationReport"},"text/plain":{"schemaId":"schema_7"},"text/html":{"schemaId":"schema_8"}},"schemaId":"components/schemas/VerificationReport"},{"code":"400","description":"Bad Request (e.g. invalid language, unknown report type)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1verify~1report/get/responses/400/content/application~1json/examples/unknownType","paths/~1documents~1{document-id}~1verify~1report/get/responses/400/content/application~1json/examples/invalidLanguage"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1verify~1report/get/responses/400/content/application~1json/examples/unknownType","paths/~1documents~1{document-id}~1verify~1report/get/responses/400/content/application~1json/examples/invalidLanguage"]},{"code":"401","description":"Unauthorized (invalid or missing token)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1verify~1report/get/responses/401/content/application~1json/examples/invalidToken"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1verify~1report/get/responses/401/content/application~1json/examples/invalidToken"]},{"code":"404","description":"Resource not found (document expired/missing or wrong id)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1verify~1report/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1verify~1report/get/responses/404/content/application~1json/examples/notFound"]},{"code":"502","description":"Upstream/service error (HTML body)","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_2"}},"schemaId":"schema_2"}],"pointer":"/paths/~1documents~1{document-id}~1verify~1report/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VerificationReport","mediaTypes":["application/json","text/plain","text/html"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VerificationReport"},"text/plain":{"schemaId":"schema_7"},"text/html":{"schemaId":"schema_8"}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1verify~1report/get/responses/400/content/application~1json/examples/unknownType","paths/~1documents~1{document-id}~1verify~1report/get/responses/400/content/application~1json/examples/invalidLanguage"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1verify~1report/get/responses/400/content/application~1json/examples/unknownType","paths/~1documents~1{document-id}~1verify~1report/get/responses/400/content/application~1json/examples/invalidLanguage"]}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1verify~1report/get/responses/401/content/application~1json/examples/invalidToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1documents~1{document-id}~1verify~1report/get/responses/401/content/application~1json/examples/invalidToken"]}}},{"code":"404","schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1verify~1report/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotFoundResponse","exampleIds":["paths/~1documents~1{document-id}~1verify~1report/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"502","schemaId":"schema_2","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_2"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/documents/verifydocument"}],"panels":[]}]},"httpPath":"/documents/{document-id}/verify/report"}],"content":{"contentType":"group","meta":{"name":"Documents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Documents","showPageActions":true},{"nodeType":"markdoc","content":"Upload and operate on signed documents"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/documents/","summary":"Upload document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/documents/uploaddocument","deprecated":false},{"title":"/documents/{document-id}/","summary":"Get document","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/getdocument","deprecated":false},{"title":"/documents/{document-id}/report","summary":"Get signature structure","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/getsignaturereport","deprecated":false},{"title":"/documents/{document-id}/content","summary":"Get extracted content","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/getdocumentcontent","deprecated":false},{"title":"/documents/{document-id}/verify/report","summary":"Verify document and get report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/documents/verifydocument","deprecated":false}]}]}]}]}},{"type":"group","label":"Administration","link":"/it/products/pki-on-prem/vol/openapi/administration","routeSlug":"/it/products/pki-on-prem/vol/openapi/administration","items":[{"label":"Upload CA certificate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/pki-on-prem/vol/openapi/administration/addcacertificate","routeSlug":"/it/products/pki-on-prem/vol/openapi/administration/addcacertificate","metadata":{"seo":{"title":"Upload CA certificate","description":"Upload (add) a Certification Authority (CA) certificate to the system."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addCaCertificate","name":"Upload CA certificate","isWebhook":false,"pointer":"/paths/~1admin~1certificates~1/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload CA certificate","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload (add) a Certification Authority (CA) certificate to the system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation is intended to add a CA that is not present among the trusted ones already configured."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a token with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"administrator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" privileges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and contains:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"certificate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the certificate to add (typically base64 / PEM content as a string, per examples)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (optional): object with any of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trusted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tsa"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthToken","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token-based authentication header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: token 0540c6085962614ab245e07963d9aa68"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddCaCertificateRequest","exampleIds":["paths/~1admin~1certificates~1/post/requestBody/content/application~1json/examples/add"]}},"schemaId":"components/schemas/AddCaCertificateRequest","exampleIds":["paths/~1admin~1certificates~1/post/requestBody/content/application~1json/examples/add"],"pointer":"/paths/~1admin~1certificates~1/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/admin/certificates/","servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthToken","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddCaCertificateRequest","exampleIds":["paths/~1admin~1certificates~1/post/requestBody/content/application~1json/examples/add"]}},"responseCodes":["201","401","502"],"pointer":"/admin/certificates/","href":"administration/addcacertificate","openApiOperationId":"addCaCertificate","summary":"Upload CA certificate"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com"}}}],"schemaId":"components/schemas/AddCaCertificateRequest","exampleIds":["paths/~1admin~1certificates~1/post/requestBody/content/application~1json/examples/add"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddCaCertificateRequest","exampleIds":["paths/~1admin~1certificates~1/post/requestBody/content/application~1json/examples/add"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"CA certificate added successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CaCertificateAdditionReport"}},"schemaId":"components/schemas/CaCertificateAdditionReport"},{"code":"401","description":"Unauthorized (invalid or missing token)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1admin~1certificates~1/post/responses/401/content/application~1json/examples/invalidToken"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1admin~1certificates~1/post/responses/401/content/application~1json/examples/invalidToken"]},{"code":"502","description":"Upstream/service error (HTML body)","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_2"}},"schemaId":"schema_2"}],"pointer":"/paths/~1admin~1certificates~1/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/CaCertificateAdditionReport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CaCertificateAdditionReport"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1admin~1certificates~1/post/responses/401/content/application~1json/examples/invalidToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1admin~1certificates~1/post/responses/401/content/application~1json/examples/invalidToken"]}}},{"code":"502","schemaId":"schema_2","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_2"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/administration/addcacertificate"}],"panels":[]}]},"httpPath":"/admin/certificates/"},{"label":"Get CA certificates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/it/products/pki-on-prem/vol/openapi/administration/listcacertificates","routeSlug":"/it/products/pki-on-prem/vol/openapi/administration/listcacertificates","metadata":{"seo":{"title":"Get CA certificates","description":"Retrieve the CA certificates stored on the system as a paginated JSON report.Requires a token with administrator privileges."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCaCertificates","name":"Get CA certificates","isWebhook":false,"pointer":"/paths/~1admin~1certificates~1/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get CA certificates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve the CA certificates stored on the system as a paginated JSON report."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires a token with "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"administrator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" privileges."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering parameters are modeled as query parameters (the documentation lists them as \"in the request body\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"but for HTTP GET they are typically passed as query parameters)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"AuthToken","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token-based authentication header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: token 0540c6085962614ab245e07963d9aa68"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_9","description":"Page number (pagination)"},{"name":"where_subject","in":"query","schemaId":"schema_5","description":"Filter by any string in the certificate Subject"},{"name":"where_issuer","in":"query","schemaId":"schema_5","description":"Filter by any string in the certificate Issuer"},{"name":"where_cert_id","in":"query","schemaId":"schema_5","description":"Filter by any string in the Certificate ID"},{"name":"where_serial_number","in":"query","schemaId":"schema_5","description":"Filter by any string in the Certificate SerialNumber"},{"name":"where_not_before","in":"query","schemaId":"schema_10","description":"Minimum validity date (ISO 8601)","example":"2013-06-05T17:35:47.000Z"},{"name":"where_not_after","in":"query","schemaId":"schema_5","description":"Maximum validity date (ISO 8601)","example":"2043-06-05T17:35:47.000Z"},{"name":"where_tags","in":"query","schemaId":"schema_5","description":"Filter by tags associated with the certificate"}],"pointer":"/paths/~1admin~1certificates~1/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/admin/certificates/","servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com"}}}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_9"},{"name":"where_subject","in":"query","required":false,"schemaId":"schema_5"},{"name":"where_issuer","in":"query","required":false,"schemaId":"schema_5"},{"name":"where_cert_id","in":"query","required":false,"schemaId":"schema_5"},{"name":"where_serial_number","in":"query","required":false,"schemaId":"schema_5"},{"name":"where_not_before","in":"query","required":false,"example":"2013-06-05T17:35:47.000Z","schemaId":"schema_10"},{"name":"where_not_after","in":"query","required":false,"example":"2043-06-05T17:35:47.000Z","schemaId":"schema_5"},{"name":"where_tags","in":"query","required":false,"schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"AuthToken","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","502"],"pointer":"/admin/certificates/","href":"administration/listcacertificates","openApiOperationId":"listCaCertificates","summary":"Get CA certificates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Paginated list of CA certificates","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CaCertificateRetrievalReport"}},"schemaId":"components/schemas/CaCertificateRetrievalReport"},{"code":"401","description":"Unauthorized (invalid or missing token)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1admin~1certificates~1/get/responses/401/content/application~1json/examples/invalidToken"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1admin~1certificates~1/get/responses/401/content/application~1json/examples/invalidToken"]},{"code":"502","description":"Upstream/service error (HTML body)","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_2"}},"schemaId":"schema_2"}],"pointer":"/paths/~1admin~1certificates~1/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CaCertificateRetrievalReport","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CaCertificateRetrievalReport"}}},{"code":"401","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1admin~1certificates~1/get/responses/401/content/application~1json/examples/invalidToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1admin~1certificates~1/get/responses/401/content/application~1json/examples/invalidToken"]}}},{"code":"502","schemaId":"schema_2","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_2"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/administration/listcacertificates"}],"panels":[]}]},"httpPath":"/admin/certificates/"}],"content":{"contentType":"group","meta":{"name":"Administration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Administration","showPageActions":true},{"nodeType":"markdoc","content":"Admin-only operations (requires an administrator token)"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/admin/certificates/","summary":"Upload CA certificate","prefix":{"name":"post","color":"post"},"badges":[],"link":"/administration/addcacertificate","deprecated":false},{"title":"/admin/certificates/","summary":"Get CA certificates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/administration/listcacertificates","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/UploadDocumentResponse":{"id":"components/schemas/UploadDocumentResponse","kind":"json-schema","title":"UploadDocumentResponse","data":{"type":"object","required":["code","location"],"properties":{"code":{"type":"string","example":"201 Created"},"location":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relative URL to access the uploaded document (contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"example":"/documents/e4d13719410fae2f"}}}},"components/schemas/NotFoundResponse":{"id":"components/schemas/NotFoundResponse","kind":"json-schema","title":"NotFoundResponse","data":{"type":"object","required":["code"],"properties":{"code":{"type":"string","example":"404 Not Found"},"description":{"type":"string","nullable":true}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","description":"Generic error payload (shape varies by endpoint)","additionalProperties":true,"properties":{"title":{"type":"string"},"description":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"}}}},"components/schemas/SignatureReportEnvelope":{"id":"components/schemas/SignatureReportEnvelope","kind":"json-schema","title":"SignatureReportEnvelope","data":{"type":"object","required":["code","result"],"properties":{"code":{"type":"string","example":"200 OK"},"result":{"type":"object","required":["report","errors"],"properties":{"report":{"$ref":"#/components/schemas/SignatureStructure"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}}}}},"components/schemas/SignatureStructure":{"id":"components/schemas/SignatureStructure","kind":"json-schema","title":"SignatureStructure","data":{"type":"object","description":"Signature structure for CAdES signatures (CMS SignedData-oriented).\nThe exact structure can be large and depends on the signature contents; the schema is permissive but documents key parts.\n","additionalProperties":true,"properties":{"content_type":{"type":"string","description":"OID of the content (e.g. SignedData OID)","example":"1.2.840.113549.1.7.2"},"content_name":{"type":"string","description":"Common name associated with the OID","example":"signedData"},"content":{"type":"object","additionalProperties":true}}}},"components/schemas/ValidationError":{"id":"components/schemas/ValidationError","kind":"json-schema","title":"ValidationError","data":{"type":"object","additionalProperties":true,"properties":{"where":{"type":"string","description":"JSON path / identifier of where the error occurred"},"what":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error identifier key (can be mapped via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"messages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in verification report)"},"children":[]}]}]}]}}}},"components/schemas/VerificationReport":{"id":"components/schemas/VerificationReport","kind":"json-schema","title":"VerificationReport","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verification report object returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /documents/{document-id}/verify/report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The documentation shows a rich structure with report metadata, validation results, profiles, and localized messages."},"children":[]}]}]}],"additionalProperties":true,"properties":{"report":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"High-level report info (e.g. now, type, document_uri, signed_data, ...)"},"children":[]}]}]}]},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}},"content":{"type":"object","nullable":true,"additionalProperties":true,"description":"Present for nested (matrioska) signatures"},"data":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload/processing metadata (lang, upload_time, documentid, document_hash, ...)"},"children":[]}]}]}]},"messages":{"type":"object","additionalProperties":{"type":"string"},"description":"Localized message map, keyed by error identifiers"},"validation":{"type":"object","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation details (signatures[], timestamps[], ...)"},"children":[]}]}]}]}}}},"components/schemas/AddCaCertificateRequest":{"id":"components/schemas/AddCaCertificateRequest","kind":"json-schema","title":"AddCaCertificateRequest","data":{"type":"object","required":["certificate"],"additionalProperties":false,"properties":{"certificate":{"type":"string","description":"Certificate content (as string, e.g. base64/PEM as provided by clients)"},"tags":{"type":"object","description":"Optional tags to classify the certificate","additionalProperties":true,"properties":{"chain":{"type":"object","additionalProperties":true},"trusted":{"type":"object","additionalProperties":true},"tsa":{"type":"object","additionalProperties":true}}}}}},"components/schemas/CaCertificateAdditionReport":{"id":"components/schemas/CaCertificateAdditionReport","kind":"json-schema","title":"CaCertificateAdditionReport","data":{"type":"object","description":"Report returned after adding a CA certificate","additionalProperties":true,"properties":{"data":{"type":"object","additionalProperties":true,"properties":{"hash":{"type":"string","nullable":true},"certificate":{"type":"string"},"tags":{"type":"object","additionalProperties":true},"not_before":{"$ref":"#/components/schemas/CertValidityTime"},"not_after":{"$ref":"#/components/schemas/CertValidityTime"},"cert_id":{"type":"string"},"serial_number":{"type":"string"},"subject":{"type":"string"},"issuer":{"type":"string"}}}}}},"components/schemas/CaCertificateRetrievalReport":{"id":"components/schemas/CaCertificateRetrievalReport","kind":"json-schema","title":"CaCertificateRetrievalReport","data":{"type":"object","description":"Paginated report returned when listing CA certificates","additionalProperties":true,"properties":{"pagination":{"type":"object","additionalProperties":true,"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"page":{"type":"integer"},"pages":{"type":"integer"},"previus":{"type":"string","nullable":true}}},"meta":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string","example":"200 OK"}}},"data":{"type":"array","items":{"$ref":"#/components/schemas/CaCertificateItem"}}}}},"components/schemas/CaCertificateItem":{"id":"components/schemas/CaCertificateItem","kind":"json-schema","title":"CaCertificateItem","data":{"type":"object","additionalProperties":true,"properties":{"hash":{"type":"string","nullable":true},"certificate":{"type":"string"},"tags":{"type":"object","additionalProperties":true},"not_before":{"$ref":"#/components/schemas/CertValidityTime"},"not_after":{"$ref":"#/components/schemas/CertValidityTime"},"cert_id":{"type":"string"},"serial_number":{"type":"string"},"subject":{"type":"string"},"issuer":{"type":"string"}}}},"components/schemas/CertValidityTime":{"id":"components/schemas/CertValidityTime","kind":"json-schema","title":"CertValidityTime","data":{"type":"object","additionalProperties":true,"properties":{"option":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASN.1 time option (GENERAL_TIME or UTC_TIME)"},"children":[]}]}]}],"example":"UTC_TIME"},"utc":{"type":"boolean","description":"True if time is UTC-based"},"value":{"type":"string","description":"ISO 8601 datetime","example":"2043-06-05T17:35:47"}}}},"schema_0":{"kind":"json-schema","data":{"type":"object","required":["document"],"properties":{"document":{"type":"string","format":"binary","description":"Main document to upload (must be signed when using embedded signatures)"},"content":{"type":"string","format":"binary","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detached signature (optional). If omitted, VOL searches for the signature inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"verification_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verification date to be used by VOL."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The documentation describes this as a form field named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verification_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2017-12-20T11:46:36.862950"}}},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"object","properties":{"location":{"type":"string","example":"/documents/e4d13719410fae2f","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Relative URL of the uploaded document (contains the unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"document-id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}}},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","description":"HTML error page"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string","pattern":"^[0-9a-fA-F]+$"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"string"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string","minLength":2,"maxLength":2},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded PDF report (when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type=rml"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"template=report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"string","description":"HTML report (may be returned by the service depending on configuration/parameters)"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"integer","minimum":1},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 datetime (%Y-%m-%dT%H:%M:%S.%fZ)"},"children":[]}]}]}]},"id":"schema_10"}},"exampleStore":{"paths/~1documents~1/post/responses/201/content/application~1json/examples/ok":{"value":{"code":"201 Created","location":"/documents/e4d13719410fae2f"},"key":"ok","summary":"ok","id":"paths/~1documents~1/post/responses/201/content/application~1json/examples/ok"},"paths/~1documents~1/post/responses/400/content/application~1json/examples/invalidBoundary":{"value":{"title":"Error parsing file","description":"Invalid boundary in multipart form:''"},"key":"invalidBoundary","summary":"invalidBoundary","id":"paths/~1documents~1/post/responses/400/content/application~1json/examples/invalidBoundary"},"paths/~1documents~1/post/responses/401/content/application~1json/examples/invalidToken":{"value":{"title":"401 Unauthorized","description":"Invalid Token"},"key":"invalidToken","summary":"invalidToken","id":"paths/~1documents~1/post/responses/401/content/application~1json/examples/invalidToken"},"paths/~1documents~1{document-id}~1/get/responses/401/content/application~1json/examples/invalidToken":{"value":{"title":"401 Unauthorized","description":"Invalid Token"},"key":"invalidToken","summary":"invalidToken","id":"paths/~1documents~1{document-id}~1/get/responses/401/content/application~1json/examples/invalidToken"},"paths/~1documents~1{document-id}~1/get/responses/404/content/application~1json/examples/notFound":{"value":{"code":"404 Not Found"},"key":"notFound","summary":"notFound","id":"paths/~1documents~1{document-id}~1/get/responses/404/content/application~1json/examples/notFound"},"paths/~1documents~1{document-id}~1report/get/responses/401/content/application~1json/examples/invalidToken":{"value":{"title":"401 Unauthorized","description":"Invalid Token"},"key":"invalidToken","summary":"invalidToken","id":"paths/~1documents~1{document-id}~1report/get/responses/401/content/application~1json/examples/invalidToken"},"paths/~1documents~1{document-id}~1report/get/responses/404/content/application~1json/examples/notFound":{"value":{"code":"404 Not Found"},"key":"notFound","summary":"notFound","id":"paths/~1documents~1{document-id}~1report/get/responses/404/content/application~1json/examples/notFound"},"paths/~1documents~1{document-id}~1content/get/responses/401/content/application~1json/examples/invalidToken":{"value":{"title":"401 Unauthorized","description":"Invalid Token"},"key":"invalidToken","summary":"invalidToken","id":"paths/~1documents~1{document-id}~1content/get/responses/401/content/application~1json/examples/invalidToken"},"paths/~1documents~1{document-id}~1content/get/responses/404/content/application~1json/examples/notFound":{"value":{"code":"404 Not Found"},"key":"notFound","summary":"notFound","id":"paths/~1documents~1{document-id}~1content/get/responses/404/content/application~1json/examples/notFound"},"paths/~1documents~1{document-id}~1verify~1report/get/responses/400/content/application~1json/examples/unknownType":{"value":{"code":"404 Not Found","description":"Unknow report type"},"key":"unknownType","summary":"unknownType","id":"paths/~1documents~1{document-id}~1verify~1report/get/responses/400/content/application~1json/examples/unknownType"},"paths/~1documents~1{document-id}~1verify~1report/get/responses/400/content/application~1json/examples/invalidLanguage":{"value":{"message":"Invalid language. Languages supported are: [ 'it', 'en' ]"},"key":"invalidLanguage","summary":"invalidLanguage","id":"paths/~1documents~1{document-id}~1verify~1report/get/responses/400/content/application~1json/examples/invalidLanguage"},"paths/~1documents~1{document-id}~1verify~1report/get/responses/401/content/application~1json/examples/invalidToken":{"value":{"title":"401 Unauthorized","description":"Invalid Token"},"key":"invalidToken","summary":"invalidToken","id":"paths/~1documents~1{document-id}~1verify~1report/get/responses/401/content/application~1json/examples/invalidToken"},"paths/~1documents~1{document-id}~1verify~1report/get/responses/404/content/application~1json/examples/notFound":{"value":{"code":"404 Not Found"},"key":"notFound","summary":"notFound","id":"paths/~1documents~1{document-id}~1verify~1report/get/responses/404/content/application~1json/examples/notFound"},"paths/~1admin~1certificates~1/post/requestBody/content/application~1json/examples/add":{"value":{"certificate":"MIIF...base64...","tags":{"trusted":{},"chain":{},"tsa":{}}},"key":"add","summary":"add","id":"paths/~1admin~1certificates~1/post/requestBody/content/application~1json/examples/add"},"paths/~1admin~1certificates~1/post/responses/401/content/application~1json/examples/invalidToken":{"value":{"title":"401 Unauthorized","description":"Invalid Token"},"key":"invalidToken","summary":"invalidToken","id":"paths/~1admin~1certificates~1/post/responses/401/content/application~1json/examples/invalidToken"},"paths/~1admin~1certificates~1/get/responses/401/content/application~1json/examples/invalidToken":{"value":{"title":"401 Unauthorized","description":"Invalid Token"},"key":"invalidToken","summary":"invalidToken","id":"paths/~1admin~1certificates~1/get/responses/401/content/application~1json/examples/invalidToken"}},"securitySchemeStore":{"AuthToken":{"id":"AuthToken","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token-based authentication header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: token 0540c6085962614ab245e07963d9aa68"},"children":[]}]}]}],"in":"header","paramName":"Authorization"}},"specVersion":"3.0.3","servers":[{"url":"https://{address}/api","variables":{"address":{"default":"example.com","description":"FQDN (or host:port) where VOL is deployed"}}}],"specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/@l10n/it/products/pki-on-prem/VOL/openapi.json?download"},{"url":"/_bundle/@l10n/it/products/pki-on-prem/VOL/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"VOL (On-Line Verifier) API","description":"OpenAPI specification generated from the provided VOL documentation.\n\n**Authentication**\nAll endpoints are protected by token-based authentication via the `Authorization` header:\n`Authorization: token <token-value>`.\n\n**Base URL**\nAll paths below are relative to:\n`https://{address}/api`\n\n**Caching**\nUploaded documents are kept in cache for a configurable time window. After expiry, the document\nis deleted and must be uploaded again.\n"}},"baseSlug":"/it/products/pki-on-prem/vol/openapi","routesMapping":{}}