Schemas
LoginRequest
usernameYour API key name
api-keyYour API key secret
ProblemResponse
typeURI identifying the problem category. The host of this URI depends on
the environment the request was made against (e.g.
document-validation.skribble.com and document-validation.skribble.de
for the production regions; other environments use their respective
hosts). Match on the path segment after /problem/ rather than the full
URI. Known values:
https://document-validation.skribble.com/problem/problem-with-message— generic error with a messagehttps://document-validation.skribble.com/problem/entity-not-found— requested resource does not existhttps://document-validation.skribble.com/problem/feature-not-enabled— a required feature is not enabled for the businesshttps://document-validation.skribble.com/problem/constraint-violation— request violates a domain constrainthttps://document-validation.skribble.com/problem/limit-exceeded— a usage limit was exceeded
methodHTTP method of the failing request.
pathRequest URI of the failing request.
statusHTTP status code, mirroring the response status line.
messageHuman-readable error message.
keyOptional machine-readable error key. Reserved for future use.
Signer
validsignertimequalitylegislationlongTermValidationvisualDifferencesundefinedChangesSignerInfosResponse
validsignertimequalitylegislationlongTermValidationvisualDifferencesundefinedChangesFormatInfosResponse
fileTypeFile Type
quality(Optional) File Type Quality
producer(Optional) File producer
DocumentValidationResponse
idvalidsignaturesNumber of signatures found
validSignaturesNumber of valid signatures found
qualityHighest signature quality found
legislationIdentified legislation (CH, EU, CH-EU, WORLD)
longTermValidationAll signatures are provided with long-term validation information
visualDifferencesIndicates if visual differences were detected
undefinedChangesIndicates if undefined changes were detected
(Optional) Additional information details
SignatureValidationResponse
idvalidsignaturesNumber of signatures found
validSignaturesNumber of valid signatures found
qualityHighest signature quality found
legislationIdentified legislation (CH, EU, CH-EU, WORLD)
longTermValidationAll signatures are provided with long-term validation information
(Optional) Additional information details
CreditInfo
skuSKU of the API endpoint
endpointAPI endpoint
creditsCredit usage per successful API endpoint call
BillingCreditInfos
validFromISO 8601 date-time in UTC
Array of consumptions, each with endpoint details and its credit cost
CreditUsage
endpointThe API endpoint being consumed
requestsNumber of credits consumed by the endpoint call
creditsThe number of credits consumed through the corresponding endpoint