🙎🏽‍♂️ What an Identity is#

An identity identifies your user entity in the scope of fetchdocs. It can be a user, a company, or an account. You can create as many identities as you need.

For the case that your applications shares the products data by using "teams" or "accounts" you can create an identity for each of those teams or accounts. This way, the team shares the credentials, which are mostly team-related in a business context, rather than the individual user.

You are still free to create an identity for each user, but it's recommend to use the team or account approach. If you are unsure what approach to use, please contact the fetchdocs support team. They're happy to assist you.

📝 Create an Identity#

To create an identity, you need to send a POST request to the identities endpoint of the fetchdocs API. You need to provide the following information in the request body:

• name: The name of the identity. This can be the name of the user, the company, or the account.
• client_identifier: The identifier of the client. This is the identifier of the representing entity in your app. This can be the user ID, the company ID, or the account ID.

The response of the request contains the uuid of the identity. You need to store this uuid in your app to use it for further requests, like requesting a UI token.

The client_identifier must be unique in each environment. If the client_identifier is already used for another identity, the request fails with a 402 Unprocessable Entitiy status code.

📘 API reference

For more information about the API endpoint POST /identities, please refer to the API reference.