# Description

#### **Table of Contents**

- [Description](#bkmrk-description)
- [Examples](#bkmrk-examples)
- [Cookbook](#bkmrk-cookbook)
- [F.A.Q.](#bkmrk-api-documentation)
- [API Documentation](#bkmrk-api-documentation)

#### **Description**

##### *Financial meaning*

It stores the data of an individual client. It provides a single point of access to user data and **API** keys (third-party services) associated with customer portfolios.

##### *Platform abstraction*

A **Client** in Finmars platform is a container for client information, this entity is referenced by:

- [client\_secret](https://docs.finmars.com/books/client-entity/page/client-secret "Clietn Entity") an entity that stores the API keys to the brokers, one client's connection to many secrets.
- [portfolio](https://docs.finmars.com/books/entities/chapter/portfolio "Client Entity") container for financial assets, one client's connection to many portfolios.

#### **Examples**

<table border="1" id="bkmrk-" style="border-collapse: collapse; width: 100%;"><thead><tr><td class="align-center" style="width: 7.50894%;">Name</td><td class="align-center" style="width: 11.2038%;">Short Name  
</td><td style="width: 13.4598%;">Public Name</td><td class="align-center" style="width: 11.57%;">First Name  
</td><td class="align-center" style="width: 10.3695%;">Last Name</td><td class="align-center" style="width: 12.7533%;">User code  
</td><td class="align-center" style="width: 8.10489%;">Notes</td><td class="align-center" style="width: 12.5149%;">Email</td><td class="align-center" style="width: 12.5149%;">Phone  
</td></tr></thead><tbody><tr><td style="width: 7.50894%;">J-Doe</td><td style="width: 11.2038%;">J-Doe  
</td><td style="width: 13.4598%;">J-Doe</td><td style="width: 11.57%;">Josh</td><td style="width: 10.3695%;">Doe</td><td style="width: 12.7533%;">client-00</td><td style="width: 8.10489%;">-</td><td style="width: 12.5149%;">J.Doe@bank-c.com</td><td style="width: 12.5149%;">+8812345</td></tr></tbody></table>

- `User code`: workspace unique identifier of the client
- `Name`: full name
- `Short name`: short name, showed in other relations
- `Public name`: public view name for users without access
- `First name`: public view name for users without access
- `Last name`: public view name for users without access
- `Notes`: custom description
- `Email`: client's email
- `Phone`: client's phone number (5-15 digits long)

#### **Cookbook**

##### *CRUD* 

Operations within platform.

##### *Use Cases*

What for it's used.

#### **F.A.Q.**

Frequently asked questions.

#### **API documentation**

Link to API documentation.