Tenant API - Developer Guide

StoRegister API Documentation
StoRegister - Contact Book

Tenant API

The Tenant API documentation encompasses various endpoints tailored to manage and retrieve tenant-specific information. Explore the following tenant-specific endpoints to seamlessly interact with the platform.

Tenant Information Get API

This endpoint facilitates the retrieval of comprehensive information about the Tenant, encompassing primary profile details, valuable insights, a detailed list of contracts, and an overview of unpaid invoices. It provides a holistic view of the Tenant's engagement and financial interactions with the platform.

Explore endpoints

Tenant Profile Get API

This endpoint retrieves the profile information of the logged-in user, encompassing primary details, address information, and profile image.

Explore endpoints

Update Tenant Profile API

This endpoint allows updating the logged-in user's profile information, including primary and communication address details, to keep their profile up to date.

Explore endpoints

Update Tenant Profile Display Picture API

The Update Tenant Profile Display Picture API offers a secure endpoint for users to modify their profile images. By making a PUT request to the designated endpoint, logged-in users can update their display pictures. The API supports multipart/form-data with a specified boundary for seamless image uploads.

Explore endpoints

Tenant Password Update Request API

This endpoint is designed to generate a concurrency stamp for updating the password, preventing duplicate requests. The response will include the newly generated concurrency stamp, which must be sent along with the change password payload to execute the operation successfully.

Explore endpoints

Tenant Password Update API

This API endpoint facilitates the update of a new password by validating it against the existing password along with the concurrency stamp. If the validation is successful, the password will be updated; otherwise, it will return appropriate error codes for the logged-in tenant. In the case of a successful operation, it will return the client ID.

Explore endpoints