Overview

Scanning API

The Scanning API is a key component of our digital document management system, designed to seamlessly integrate scanning services into our broader digital ecosystem. This API enables scan centre partners to efficiently submit scanned documents into the system where they are processed, categorised and made available for further actions to end users.

Scans & Upload Document: The Partner initiates the process by scanning and uploading a document to the Input Scanning API.

Retrieves Shipment Reference: Following the upload, the Scanning API provides the Partner with a shipment reference for the uploaded document.

Processes Shipment: The Scanning API forwards the document to the Input Management for processing, which includes validation, categorization, and preparation for storage.

Stores Document: The PEAX-Core System stores the processed document in the Database, ensuring it's securely saved and cataloged.

Notifies Completion: Once the document is successfully stored, the PEAX-Core System notifies the Input Management about the completion of the processing and storage steps.

Notifies Rejections: If there are any issues or rejections during the processing phase, the Scanning API communicates this to the Partner, indicating that some submissions were not accepted.

Download Cover Letter: The Partner can then download a cover letter from the Scanning API, which might be required for their records or further actions regarding the scanned document.

This high-level overview provides insight into how partners interact with the Scanning API and how the API interfaces with the PEAX-Core system to manage scanned documents.

Domain Model

ShipmentInput: Represents the main input structure for a shipment, including a nested data object and a file.

Data: Contains detailed information about the shipment, such as identifiers, timestamps, and process-related flags.

SeparationInput: Describes document separation information within a shipment.

ShipmentsView and ForwardingShipmentsView: Represent collections of ShipmentInput and ForwardingShipmentView entities, respectively.

ShipmentDeliveryView and ForwardingShipmentView: Provide views for tracking shipment deliveries and forwarding requests.

ShipmentCloseInput: Used for marking shipments as closed.

ApiErrorView, Info, and ExceptionDetail: Define the structure for error handling and additional information provision.

This model visualizes the data entities involved in the scanning API and how they interact, providing a clear overview of the system's domain.

Process Model

This sequence diagram captures the flow of interactions initiated by the Partner through the Scanning API, leading to various actions within the Input Management System and ultimately involving the PEAX-Core for document storage, query, forwarding, and process closure. Each step is aligned with the provided API paths, detailing the request type, the endpoint, and the expected response or action resulting from the interaction.

Scanning API#

Domain Model#

Process Model#

Scanning API

Domain Model

Process Model