APIs

This chapter describes the APIs provided by the Risk Management Toolbox.

Validate document

POST /api/validation/

Headers

Content-Type	application/json

Body

data	`String`: PDF document, base64-encoded.
controlData	`String`: PDF control document, base64-encoded. Optional if none of the rule specified requires it
rules	`Set<Rule>`: Collection of rules that must be verified.
id	`String`: Rule ID.
configuration	`String`: A generic dictionary containing the rule's configuration.

Request Body Example

{
    "data" : "JVBERi0xLjMKJcTl8uXrp...",
    "controlData" : "JVBERi0xL3jam2x3o...",
    "rules":[
      {
        "id": "maxFileSize",
        "configuration": {
          "maxFileSize": "100KB"
        }
      },
      {
        "id": "pdfACompliance",
        "configuration": {
          "compliance": "1b"
        }
      },
      {
        "id": "visualComparison",
        "configuration": {
          "ignoreFormFields" : "true"
        }
      }
    ]
}

Response status code

200	The validation has been executed successfully, see response body for result.
400	The request or the configuration provided is invalid or incomplete.

Response body

successful	`Boolean`: Flag specifying if the validation is successful.
ruleExecutions	`Array<RuleExecution>`: Array of the executed rules:
ruleId	`String`: Rule ID
status	`String`: Execution status (`PASSED` \| `FAILED`)
violations	`Array<RuleViolation>`: Array of the violations for the given execution
message	`String`: Violation message
pageIndex	`Integer`: Page index where the failure occurred (null if N/A)
report	`String`: Base64-encoded PDF report

Response Body Example

{
    "successful" : "false",
    "report" : "JVBERi0xLjMKJcTl8uXrp...",
    "ruleExecutions":[
      {
        "ruleId" : "fileReadable",
        "status" : "PASSED",
        "violations" : []
      },
      {
        "ruleId" : "maxFileSize",
        "status" : "FAILED",
        "violations" : [
          {
            "message" : "Document has exceeded the max file size (10000000 Bytes). Actual size : 12530300 Bytes",
            "pageIndex" : null
          }
        ]
      }
    ]
}

Validate document using a pre-configured profile

This API allow you to validate a document using an existing profile.

The profile are statically configured with a list of the rules to be executed and a default configuration. It's not necessary to specify rules defined in a profile in the request's body, unless its configuration needs to be overridden.

It is allowed to add new rule to the request that are not defined in the given profile.

API

POST /api/validation/profiles/{profileId}