Document Split

By default the API analyses the document as a whole. To request splitting into separate subdocuments before further analysis, you can first specify only the split analyse type in the payload of your request. You can then submit each separated document independently for further analyses (risk, explanation, etc.).

Payload

Payload Key	Description
split	Splits the document into parts (lists of page numbers). Each part can then be analysed independently.

These settings must be added in the payload parameter of the API call.

note

Make sure that your subscription includes access to the split analysis type.

Example Payload:

{
    "analyse_type": ["split"]
}

Response Format

The API returns the document split into multiple parts as separate PDF files encoded in base64. Each key represents the filename of a part, and each value contains the base64-encoded content of that PDF part.

You can then decode each base64 string to get the individual PDF files and submit them separately to the API for further analyses (risk, explanation, etc.).

Example Response:

{
    "splitted_files": {
        "sample_part1.pdf": "JVBERi0xLjcKJcK1wrYKCjEgMCBvYmoKP...",
        "sample_part2.pdf": "JVBERi0xLjcKJcK1wrYKCjEgMCBvYmoKP..."
    }
}