Gallery

Endpoints for working with the gallery.

Availability

Gallery is available only for Business and Enterprise plans.

Client gallery

This section describes work with the client's general gallery.

List files in client gallery

GET /api/v1/Gallery/Client/{idClient}/Files

Returns a paginated list of files in the client's gallery.

Query parameters

Parameter	Type	Required	Default	Description
Page	int	no	1	Page number
PageSize	int	no	25	Number of items per page, max. 25
TagIds	uuid[]	no	-	Filter by tags
RequireAllTagIds	bool	no	false	false = any tag match is enough, true = file must contain all specified tags

Path parameters

Parameter	Type	Required	Description
idClient	uuid	yes	Client identifier

Response

Field	Type	Description
Page	int	Current page
PageSize	int	Page size
Total	int	Total number of files matching filters
Results	GalleryFileItem[]	Files in the client gallery

GalleryFileItem

Field	Type	Description
IdFile	uuid	File identifier
Name	string	File name
Description	string	File description
MimeType	string	MIME type
Extension	string	File extension
Size	long	File size in bytes
DateCreated	datetime	Creation date
Tags	GalleryTagItem[]	File tags

GalleryTagItem

Field	Type	Description
IdTag	uuid	Tag identifier
Tag	string	Tag name

Notes

• Biometrically signed files are not returned in the list.

---

Download file from client gallery

GET /api/v1/Gallery/Client/{idClient}/Files/{idFile}

Returns file content.

Query parameters

Parameter	Type	Required	Default	Description
ImageAsType	enum	no	Raw	Output format: Raw, ByteStream, Base64

Path parameters

Parameter	Type	Required	Description
idClient	uuid	yes	Client identifier
idFile	uuid	yes	File identifier

Response

Mode	Response type	Description
Raw	binary stream	File in original MIME type
ByteStream	binary stream	File as application/octet-stream
Base64	string	Base64 representation of file content

Notes

• File name is included in the Content-Disposition response header (filename).

Error states

Status	Code	Description
404	CLIENT_NOT_FOUND	Client does not exist
404	FILE_NOT_FOUND	File does not exist

---

Get file thumbnail from client gallery

GET /api/v1/Gallery/Client/{idClient}/Files/{idFile}/Thumbnail

Returns file thumbnail.

Query parameters

Parameter	Type	Required	Default	Description
SizeX	int	no	100	Thumbnail width in px (50 to 1000)
SizeY	int	no	100	Thumbnail height in px (50 to 1000)
ThumbnailAsType	enum	no	Raw	Output format: Raw, ByteStream, Base64

Path parameters

Parameter	Type	Required	Description
idClient	uuid	yes	Client identifier
idFile	uuid	yes	File identifier

Response

Mode	Response type	Description
Raw	binary stream	File in original MIME type
ByteStream	binary stream	File as application/octet-stream
Base64	string	Base64 representation of file content

Error states

Status	Code	Description
400	VALIDATION_FAILED	Invalid thumbnail dimensions
404	CLIENT_NOT_FOUND	Client does not exist
404	FILE_NOT_FOUND	File does not exist

---

Upload file to client gallery

POST /api/v1/Gallery/Client/{idClient}/Files

Uploads a file to the client's gallery.

Path parameters

Parameter	Type	Required	Description
idClient	uuid	yes	Client identifier

Request body (multipart/form-data)

Parameter	Type	Required	Description
File	file	yes	Uploaded file
FileName	string	no	File name override including extension

Response

Field	Type	Description
IdFile	uuid	File identifier
IdClient	uuid	Client identifier
Name	string	File name
MimeType	string	MIME type
Extension	string	File extension
Size	long	Size in bytes
DateCreated	datetime	Creation date

Notes

• Maximum file size is 25 MB.
• If FileName is not provided, the uploaded file name is used.

Limits

Each client gallery has a total size limit based on the plan.

• Business: 100 MB
• Enterprise: 200 MB (or a custom configured limit)

Error states

Status	Code	Description
400	MISSING_FILE	File is missing
400	VALIDATION_FAILED	Invalid name or extension
404	CLIENT_NOT_FOUND	Client does not exist
409	GALLERY_LIMIT_EXCEEDED	Client gallery limit exceeded

---

Add tags to file in client gallery

POST /api/v1/Gallery/Client/{idClient}/Files/{idFile}/Tags

Adds tags to a file. Existing tags remain unchanged.

Path parameters

Parameter	Type	Required	Description
idClient	uuid	yes	Client identifier
idFile	uuid	yes	File identifier

Request body (application/json)

Parameter	Type	Required	Description
Tags	GalleryTagInput[]	yes	List of tags to add

Each item in Tags must contain at least IdTag or Tag.

GalleryTagInput

Field	Type	Required	Description
IdTag	uuid	conditional	ID of an existing tag
Tag	string	conditional	Tag name if IdTag is not provided

Response

Response is a GalleryTagItem[] array.

GalleryTagItem

Field	Type	Description
IdTag	uuid	Tag identifier
Tag	string	Tag name

Notes

• Tag name matching is case-insensitive.
• If a tag with the given name does not exist, the API creates it and assigns it to the file.

Error states

Status	Code	Description
400	VALIDATION_FAILED	Invalid request structure or duplicate tag
404	CLIENT_NOT_FOUND	Client does not exist
404	FILE_NOT_FOUND	File does not exist

File tags

File tags overview

GET /api/v1/Gallery/Tags

Returns all available tags for gallery files.

Parameters

This endpoint has no parameters.

Response

Response is a GalleryTagItem[] array.

GalleryTagItem

Field	Type	Description
IdTag	uuid	Tag identifier
Tag	string	Tag name