SAK REST Interface: /trusted-checker/check-document(s)

Purpose

This operation is called to prevalidate one or more documents before the actual signature creation.

Interface

SAK REST Interface (siehe [IF_SAK])

Method of use

The operation is called by a client software according to the specification as POST method on the SAK REST interface (see [IF_SAK]).

Input

Parameter

Type

Description

document

Document

Data type containing information about the document to be signed (see below).

Output

Parameter

Type

Description

proofReport

ProofReport

Data type containing the generated proof report (see below).

Error messages

Type

Reason

500

SecureFrameworkException

Component

Type

Description

JSON definition

id

String

Identifier (uuid) of the document to be checked

{"id":"[STRING]"}

fileName

String

Name of the document to be checked

{"fileName":"[STRING]"}

data

String

Data representation of the document to be checked

{"data":"[STRING]"}

Component

Type

Description

JSON definition

checkedDocuments

checkDocument []

Checking information for a document to be checked

{"checkedDocuments":" [checkDocument[]]"}

creationTime

Number

Name of the document to be checked

{"creationtime":[NUMBER]}

signature

String

Data representation of the document to be checked

{"signature":"[STRING]"}

Component

Type

Description

JSON definition

documentId

String

Identifier (uuid) of the document to be checked

{"documentId":"[STRING]"}

errorMessage

String

Possible error messages regarding the performed test

{"errorMessage":[STRING]}

hashValue

String

Hash value of the checked document

{"hashValue":"[STRING]"}

mimeType

String

mimeType of the checked document

{"mimeType":"[STRING]"}

proofResult

Boolean

Result of the proof report

{"proofResult":[BOOLEAN]}