Accessing the Uome API requires the use of a client ID and secret key, which must be obtained from Uome after you have agreed to our terms of use. The client ID is used to identify your application and the secret key is used to secure your API requests and ensure that only your application has access to the data you request from Uome. Both the client ID and secret key must be included in every API request made to Uome.

To ensure the security of your data, it is recommended that you keep your secret key confidential and store it securely. Do not include it in client-side code or share it with anyone else, as this could compromise the security of your data and your users' financial information. When making API requests, the client ID and secret key should be passed as headers in the request, along with any other required parameters and authentication information. Once you have obtained your client ID and secret key, you can start making API requests to Uome and integrating their financial services into your own application.

Uome's sign up API enables new users to create an account and have their information stored in the database. The API provides a secure and efficient way for users to sign up and get started with Uome, giving them access to all its features and benefits.

The getStarted API is used to create a new user account. It is a RESTful API that allows developers to programmatically create a new user account by sending a HTTP POST request to the API endpoint with the necessary information as the request body. Once the API is successfully executed, it returns a response indicating the status of the request and any relevant information regarding the newly created user account.

An email will be sent to the user with a validate email link.

The Uome Login API is an endpoint that allows you to authenticate users and reset their passwords. It provides a secure and convenient way for users to log into your application and access their financial information. The Login API uses industry standard authentication methods, such as email/password or OAuth2, to ensure the security of your users' data.

The Login API provides endpoints for handling user authentication and password reset functionality. When a user logs in, you can use the authentication endpoint to verify their credentials and receive an access token that can be used to make API requests on their behalf. If a user forgets their password, you can use the password reset endpoint to send a password reset email to the user. Once the user has reset their password, they can log in using the new password and access their financial information. The Login API also includes error handling and troubleshooting information, so you can easily handle any issues that arise during the login process. With the Uome Login API, you can provide your users with a secure and seamless login experience, and easily manage their financial transactions.

The authenticateJwtProfile API is used to authenticate users and retrieve their profile information. This API allows users to access their profile information after logging in to the application, by sending a HTTP POST request to the API endpoint with their JSON Web Token (JWT). The API then validates the JWT and returns the user's profile information, including details such as their name, address, and account status.

The forgotPasswordJwt API is used to enable users to reset their password if they have forgotten it. This API allows users to initiate a password reset by sending a HTTP POST request to the API endpoint with their email address. The API then generates a JSON Web Token (JWT) and sends it to the user's email address, along with instructions for resetting their password. The user can then use the JWT to access a password reset page, where they can enter a new password.

Uome's account settings API provides a secure and convenient way for users to update their information, such as personal details, or security settings. The API utilizes RESTful principles for handling requests and responses and is easily integratable with various types of applications. This API allows users to have full control over their account information, keeping it up-to-date and secure at all times.

The obtainPostAvatarUrl API is used to get a URL for uploading and storing media, such as a profile picture or avatar. This API allows the user to upload images or other media files to a server, where they can be stored and retrieved at a later time. The API generates a unique AWS signed URL for the user to upload the media to, which can then be stored in the database along with information about the user.

The upload avatar API stores the relevant file name of the image against the user collection. This profile icon serves as their visual representation in the app. This icon is also stored against the profile for use in generated documents and other parts of the app.

The profile details API is used to store information about the user profile, including the user's name, contact information, and address. This information is used to personalize the user's experience and help with communication and billing purposes.

The company details API is used to store important information about the user's company such as company name, company registration number, VAT number, and industry type. This information is used to identify the company for various business purposes such as invoicing and payment processing.

The bank details API allows users to store their banking information, such as the name on the account, account number, and sort code, for use in processing customer payments. This information is securely stored and can be easily retrieved for use in transactions, helping to streamline the payment process and reduce the risk of errors or misunderstandings. This API is an essential tool for businesses looking to improve the efficiency and reliability of their financial processes, while also maintaining the security of sensitive information.

The purchase order setting API allows businesses to enable customers to place orders directly, using items from the business's catalogue. By using this API, businesses can streamline their order process, reducing administrative overhead and improving the customer experience. This can help to drive sales and improve customer satisfaction, leading to stronger relationships and increased loyalty over time.

Go to catalogue section to for purchase order flow

The Uome Contacts API is a feature within the Uome ecosystem that allows users to add and manage contacts for their customer relationship management (CRM) purposes. This API enables users to store and organize important information about their contacts, such as their names, email addresses, and phone numbers, and use this information to build and maintain strong relationships with their customers. The API provides a simple and user-friendly interface for adding, updating, and retrieving contact information, making it easy for users to manage their customer relationships in an efficient and organized manner.

The add contacts API allows users to store information about their contacts, such as name, email, and phone number. This information can be used to manage relationships and facilitate communication with clients, suppliers, and other key stakeholders.

Uome's chat API enables users to communicate with clients through a messaging platform. The API allows users to send messages, documents, media, and actions, providing a rich and dynamic way to manage client relationships. With Uome's chat API, users can have real-time conversations, share information and files, and take actions directly within the platform, eliminating the need for multiple tools and increasing efficiency. The API is designed to be user-friendly, providing a seamless experience for both users and clients. With Uome's chat API, users can improve client relationships and streamline communication, making it easier to do business.

The group role API allows users to receive a role for group token which is used to generate messages and documents between two specific users. This information is used to determine the user's permissions and capabilities within the group.

The group list avatar API retrieves profile icons for all members in the chat function. This allows users to easily identify participants and helps to create a visually appealing interface for group conversations.

The group info API retrieves the list of groups and their details such as the name, description, and members associated with the user in the Uome ecosystem. This API provides users with an overview of all the groups they are part of, making it easier to manage and navigate the groups within the app.

The chat token API is used to verify the token for the user's access to the chat platform. This ensures secure communication by verifying the identity of the user before allowing them to send messages within the chat.

The chat history API retrieves a record of past messages and conversations for a user. It provides a convenient way for users to view previous interactions in the chat and retrieve important information.

Use skip or limit to return a certain number of messages.

The FCM chat text API enables users to send secure and encrypted text messages within the chat environment. The API uses Firebase Cloud Messaging technology to deliver the messages to the intended recipients.

The obtain upload url API retrieves a secure URL for uploading media files in the chat. The API enables users to send and store images, videos, and other types of media files in the chat.

The link content API allows users to upload and share media files such as images and videos in the chat. It helps to provide more context and make communication more engaging for all users involved in the chat.

The user info API retrieves information about the group users such as name, profile picture, role and date joined. This information can be used to manage group members and display in the chat.

The client info API retrieves relevant information about the clients for the group. This information can include the client's contact details, billing information, and any previous interactions with the group.

The get user API retrieves information about a specific user in the group, including payment information. This information can be used to manage transactions and payments within the group chat.

The geo location API is used to retrieve the client's address and display it in a navigation map app stored on the user's device. This makes it easier for the user to find the client's location and plan their route to the destination.

The contact catalogue API allows businesses to display all the items in their product catalogue to customers via the chat. This API helps customers initiate purchase orders by selecting items from the catalogue directly in the chat interface.

The quote record info API retrieves information about quotes for the user, such as the quote description, date, and price, and displays it in chat. This information is used to keep track of the quotes generated for clients and can be accessed easily for reference purposes.

The invoice record info API retrieves the necessary information about invoices, such as amount, date, and items, to display in the chat interface. This information helps the user stay organised and up-to-date with their financial transactions.

The order record Info API retrieves information about an order made by a customer for a specific product or service. This information can include the date of the order, the products or services requested, and the customer's details. The API allows this information to be displayed in the chat for easy reference and management.

The Uome Quote API includes endpoints for creating and managing quotes, including the ability to generate quotes, approve quotes, reject quotes, and send reminders. When a client generates a quote, they can use the create quote endpoint to create a quote document that outlines the terms of the proposed financial agreement. The approve quote endpoint allows clients to approve the quote and start the financial agreement. The reject quote endpoint allows clients to reject the quote if it does not meet their needs. The send reminder endpoint allows clients to send reminders to Uome about their quote and keep the quote process moving forward. With the Uome Quote API, clients have full control over their quotes and can easily manage their financial agreements with Uome.

The create quote API generates a quote for the client, providing an estimate of the cost and scope of work that will be performed. By using this API, businesses can create professional and detailed quotes that clearly communicate the services they offer, the expected results, and the associated costs. This helps to build trust and credibility with clients, improving the chances of winning new business and building strong relationships.

The approve quote API is used to mark a quote as approved and automatically convert it into an invoice for the client. This API streamlines the invoicing process, allowing clients to quickly and easily approve quotes and move on to the payment stage. By automating this process, businesses can save time and reduce the risk of errors, ensuring that invoices are generated accurately and efficiently.

The reject quote API enables clients to decline a quote that has been sent to them. By using this API, clients can quickly and easily reject a quote and provide feedback to the business about why it was not suitable for their needs. This helps businesses improve their processes and increase their chances of winning future deals.

The send quote reminder API allows businesses to send a one-off reminder to clients who have received a quote but have not yet approved or rejected it. This helps to follow up on outstanding quotes and keep the sales process moving forward, ensuring that quotes are not forgotten and helping businesses close more deals.

The get quotes API allows users to retrieve the quotes they have generated and stored within the system, filtered by month and year. This feature provides users with quick access to the quotes they need, making it easier to track quotes and their status over time.

Uome's invoice API enables users to bill clients, cancel invoices, send reminders, and manually settle invoices. The API provides a comprehensive solution for invoicing, allowing users to manage the entire process, from billing to settlement, with ease and efficiency, improving cash flow and streamlining financial operations.

The create invoice API is used to generate invoices in an automated manner. It takes the necessary information, such as the client's details and the items or services being invoiced, and creates a professional, formatted invoice that can be sent to the client.