File Storage API
The Brainysoft file storage API provides a comprehensive set of methods for managing files, their categorization, and automatic document processing. The system allows you to upload files, link them to various entities (clients, contracts, leads, applications), organize files by categories through tags, and use optical character recognition to automate document processing.
Key Features
Working with Files
The file API provides full functionality for document management in the system:
- File upload — uploading new files to the system with support for various formats
- Getting information — viewing the list of all files and detailed information on a specific file
- Editing — updating metadata of uploaded files
- Deletion — complete removal of files from the system
- Getting links — generating temporary and verified links for file access
- Bulk operations — batch processing of files (getting links and information for a group of files)
- Linking to entities — uploading and retrieving files linked to clients, contracts, leads, and applications
- Public upload — ability to upload files without authorization for public scenarios
Working with File Category Tags
The tag system allows you to organize files by categories and simplify their search and structuring:
- Creating tags — creating new categories for file classification
- Getting the list — viewing all available tags with their attributes
- Updating tags — editing names and other tag parameters
- Deleting tags — removing unnecessary categories
- Changing order — configuring the display sequence of tags
- Publishing — managing tag visibility (publishing and unpublishing)
- Statistics — getting statistical information on tag usage
Optical Character Recognition (OCR)
The file storage includes OCR (Optical Character Recognition) from partner DBrain.
Current OCR capabilities:
- Recognition of the main spread of the Russian internal passport — automatic data extraction from passport
- Selfie comparison — verification of photo match between selfie and document photo
OCR allows automatic conversion of text on images, document scans, or photographs into editable and searchable text format, which greatly simplifies document processing and process automation.
OCR functionality:
- Launching OCR processing of files
- Getting recognition results with detailed information
- Configuring recognition parameters (confidence thresholds, verification modes)
- Automatic recognition launch for files with specific tags