Uome Ltd

Shape your business with Uome's API solution. Build an online, mobile or in-person experience of your choosing.

Uome Developers - API Documentation

Introduction

API access

Versioning

Sign up

Create account

Login

Authenticate

Forgot password

User

Information

Account type

Details

Address

Bank details

Avatar upload url

Link profile avatar

Company

Sole trader

Upload files

Contacts

Add contact

Group list

Role for group

Group info

Chat fcm token

Send chat message

Obtain chat upload url

Link chat media

Group history

Quotes

Create quote

Approve quote

Cancel quote

Send reminder

Invoices

Create invoice

Settle invoice

Cancel invoice

Address request

Orders

Create order

Approve order

Reject order

Purchase orders on/off

Create POS

Settle POS

Cancel POS

Send Receipt

Catalogue

Create category

Delete category

List categories

Create item

Delete item

List items

Ledger

Real time

Expenses

Income and expenses

Financial statements

PDF report

CSV report

QuickBooks report

FreeAgent report

Xero report

Sage report

Create RTB expense

Obtain RTB upload url

Update RTB expense

Import RTB expense

Linked expenses

Cancel expense

VAT rates

VAT settings

Flat rate scheme

Create VAT return

Sales tax

Sales tax settings

Create tax rate

Default tax rate

List tax rates 

Update tax rate

Delete tax rate

Stripe

Onboard with Stripe

Retrieve Stripe account

Link Stripe account

Turn Stripe on/off

Stripe settlement

Klarna settlement

Open banking

PIS onboard

Create A2A payment

Settle A2A payment

US sanctions list

Errors

Theneo Sample Collection

Uome API Documentation

Production

Sandbox

API Docs

Uome&apos;s API Reference provides a set of endpoints for managing financial transactions between users. It allows users to send and receive payments, manage their accounts, and retrieve transaction history. The Uome API Reference Guide provides developers with the information needed to integrate Uome into their own applications, allowing them to offer their users a secure and seamless financial experience.The Uome API Reference Guide provides detailed information on each endpoint, including request and response formats, authentication methods, and sample code snippets in multiple programming languages. It also includes information on error handling and troubleshooting, as well as best practices for integrating Uome into your application. The guide is designed to be used in conjunction with the Uome API itself, making it easy for developers to start making API requests and building their financial applications.

Uome's API Reference provides a set of endpoints for managing financial transactions between users. It allows users to send and receive payments, manage their accounts, and retrieve transaction history. The Uome API Reference Guide provides developers with the information needed to integrate Uome into their own applications, allowing them to offer their users a secure and seamless financial experience.

The Uome API Reference Guide provides detailed information on each endpoint, including request and response formats, authentication methods, and sample code snippets in multiple programming languages. It also includes information on error handling and troubleshooting, as well as best practices for integrating Uome into your application. The guide is designed to be used in conjunction with the Uome API itself, making it easy for developers to start making API requests and building their financial applications.

Explore Uome's API Reference Guide, offering a range of endpoints for secure financial transactions between users. Seamlessly integrate payments, account management, and transaction history retrieval into your application.

Uome API Reference

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&apos; 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 API is versioned, which means that different versions of the API may be released over time with different features, bug fixes, and improvements. When a new version of the API is released, it is best to maintain backwards compatibility so that existing applications that are already integrated with the Uome API will continue to work as expected.It is also recommended that Uome API include a version in the URL of each API endpoint, so that developers can specify which version of the API they want to use. This allows developers to easily switch between different versions of the API as needed, and ensures that their applications will continue to work even if a new version of the API is released in the future. By following these best practices for API versioning and backwards compatibility, Uome can ensure that their API remains stable and usable for years to come.

Uome&apos;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.

Explore Uome's Sign Up API for seamless new user onboarding. Securely store user details in the database, granting instant access to Uome's array of features.

Sign Up | Uome APIs

The create account 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.<div data-type="error" style="background-color:#FFF1F1;color:#ff3030"><div ><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M9.08366 9.9801C9.25033 9.9801 9.39269 9.92107 9.51074 9.80302C9.6288 9.68496 9.68783 9.53566 9.68783 9.3551V5.31344C9.68783 5.14677 9.62533 5.00441 9.50033 4.88635C9.37533 4.7683 9.22949 4.70927 9.06283 4.70927C8.88227 4.70927 8.73296 4.7683 8.61491 4.88635C8.49685 5.00441 8.43783 5.15371 8.43783 5.33427V9.37594C8.43783 9.5426 8.50033 9.68496 8.62533 9.80302C8.75033 9.92107 8.9031 9.9801 9.08366 9.9801ZM9.00033 13.1676C9.19477 13.1676 9.35796 13.1016 9.48991 12.9697C9.62185 12.8377 9.68783 12.6745 9.68783 12.4801C9.68783 12.2857 9.62185 12.1225 9.48991 11.9905C9.35796 11.8586 9.19477 11.7926 9.00033 11.7926C8.80588 11.7926 8.64269 11.8586 8.51074 11.9905C8.3788 12.1225 8.31283 12.2857 8.31283 12.4801C8.31283 12.6745 8.3788 12.8377 8.51074 12.9697C8.64269 13.1016 8.80588 13.1676 9.00033 13.1676ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C10.9448 16.0843 12.6114 15.3898 14.0003 14.0009C15.3892 12.612 16.0837 10.9454 16.0837 9.00094C16.0837 7.05649 15.3892 5.38982 14.0003 4.00094C12.6114 2.61205 10.9448 1.9176 9.00033 1.9176C7.05588 1.9176 5.38921 2.61205 4.00033 4.00094C2.61144 5.38982 1.91699 7.05649 1.91699 9.00094C1.91699 10.9454 2.61144 12.612 4.00033 14.0009C5.38921 15.3898 7.05588 16.0843 9.00033 16.0843Z" fill="#E90005"></path></svg></div><div >Once a country code has been set for a user, it cannot be changed.</div></div>

uomeApiKey

user

Content-Type

success

message

code

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.

Explore Uome's Login API for secure user authentication and password management. Implement industry-standard methods like email/password and OAuth2 for enhanced financial data security.

Login | Uome APIs

Uome's user 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

Explore Uome's User Settings API, empowering users to securely update personal details and security settings. Utilising RESTful principles, integrate seamlessly into diverse applications for enhanced account control.

User Settings | Uome APIs

Explore Uome's Company Settings API, enabling secure updates to user information, including personal details and security settings. Leveraging RESTful principles, seamlessly integrate with diverse applications for comprehensive account control.

Company | Uome APIs

Uome uses Amazon AWS to upload media and retrieve attachments. In order to upload a file you must first obtain a pre-signed URL relevant to the API you are using e.g. chat media upload, upload avatar, expense attachment.Each AWS bucket is assigned to a specific region to comply with regulatory standards, ensuring that user data, particularly financial records, is securely stored in accordance with the relevant country&apos;s regulations.The obtain endpoint URL returns a pre-signed URL for each individual file. This is a temporary URL that allows access to the S3 bucket for a limited time period.To generate a pre-signed URL, you must use the respective ‘obtain upload url’ API for the service for e.g.
<ul class="slate-ul"><li class="slate-li"><div style="position:relative">Group media uploads - <a href="https://developers.myuome.com/apis/crm/obtain-chat-upload-url" target="_self">group/media/upload-url</a></div></li><li class="slate-li"><div style="position:relative">Profile avatar - <a href="https://developers.myuome.com/apis/user/avatar-upload-url" target="_self">user/avatar/upload-url</a></div></li><li class="slate-li"><div style="position:relative">RTB expenses attachment - <a href="https://developers.myuome.com/apis/expenses/obtain-rtb-upload-url" target="_self">expenses/rtb/upload-url</a></div></li><li class="slate-li"><div style="position:relative">Expenses attachment - <a href="https://developers.myuome.com/apis/expenses/linked-expenses/obtain-linked-expense-upload-url" target="_self">expenses/linked/upload-url</a>
</div></li></ul>Once you have the pre-signed URL, you can use it to upload your media file.Example of URL: <a href="https://uome-documents.s3.eu-west-2.amazonaws.com/test/profile/6378a5b9a226b52053441d2f/uome-logo.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&amp;X-Amz-Credential=AKIA3HTL2ZLXVMFULBGE%2F20230308%2Feu-west-2%2Fs3%2Faws4_request&amp;X-Amz-Date=20230308T143911Z&amp;X-Amz-Expires=300&amp;X-Amz-Signature=ea3d312a976edae9b9bf37b1938a2239612b808c7d1f0c4adf12708e4feef3b5&amp;X-Amz-SignedHeaders=host" target="_blank">https://uome-documents.s3.eu-west-2.amazonaws.com/test/profile/6378a5b9a226b52053441d2f/uome-logo.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&amp;X-Amz-Credential=AKIA3HTL2ZLXVMFULBGE%2F20230308%2Feu-west-2%2Fs3%2Faws4_request&amp;X-Amz-Date=20230308T143911Z&amp;X-Amz-Expires=300&amp;X-Amz-Signature=ea3d312a976edae9b9bf37b1938a2239612b808c7d1f0c4adf12708e4feef3b5&amp;X-Amz-SignedHeaders=host</a>Your client-side process can use this URL to upload the file to the relevant s3 bucket.

Uome uses Amazon AWS to upload media and retrieve attachments. In order to upload a file you must first obtain a pre-signed URL relevant to the API you are using e.g. chat media upload, upload avatar, expense attachment.

Each AWS bucket is assigned to a specific region to comply with regulatory standards, ensuring that user data, particularly financial records, is securely stored in accordance with the relevant country's regulations.

The obtain endpoint URL returns a pre-signed URL for each individual file. This is a temporary URL that allows access to the S3 bucket for a limited time period.

To generate a pre-signed URL, you must use the respective ‘obtain upload url’ API for the service for e.g.


Once you have the pre-signed URL, you can use it to upload your media file.

Your client-side process can use this URL to upload the file to the relevant s3 bucket.

Learn about Uome's efficient file upload system using Amazon AWS. Obtain pre-signed URLs for API-specific uploads such as chat media, avatars, and expense attachments, ensuring secure and time-limited access to the S3 bucket.

File Upload | Uome APIs

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 custom

Discover the Uome Contacts API, an integral feature for managing customer relationships. Store and organize contact details like names, email addresses, and phone numbers. Build and maintain strong customer connections effortlessly through this user-friendly interface.

Contacts | Uome APIs

Uome's Group CRM 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

Utilise Uome's Group CRM API for dynamic client communication. Seamlessly send messages, media, documents, and actions to manage client relationships effectively. Real-time conversations and integrated actions enhance efficiency, simplifying business communication within a user-friendly platform.

Group CRM | Uome APIs

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 star

Discover the Uome Quote API, a comprehensive solution for quote creation and management. Generate, approve, reject quotes, and send reminders seamlessly. Clients gain complete control over their financial agreements with Uome's user-friendly interface.

Quotes | Uome APIs

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.

Explore Uome's Invoice API, a versatile tool for billing clients, managing invoices, and improving cash flow. Effortlessly create, cancel, send reminders, and manually settle invoices, streamlining financial operations with Uome's efficient solution.

Invoices | Uome APIs

Uome's purchase order API enables clients to make orders directly to the business user with built-in approval flows. The API streamlines the ordering process, allowing clients to place orders and receive approvals in a timely and efficient manner, while also providing the necessary transparency and accountability to manage the procurement process effectively.

Discover Uome's Purchase Order API, empowering clients to streamline orders and approval flows. Effortlessly place orders, receive timely approvals, and enhance procurement process transparency for effective management.

Orders | Uome APIs

The POS (Point of Sale) API is a key component of the Uome ecosystem which allows users to generate transactions and accept quick in-person payments from clients. This API integrates with the user's existing payment system and provides real-time transactions for efficient checkout processes. By using the POS API, users can streamline the payment process and reduce the time required for ma

Discover the Point of Sale (POS) API by Uome, enabling seamless transactions and swift in-person payments. Integrate with your existing payment system for real-time, efficient checkout processes, elevating business efficiency.

Point of Sale (POS) | Uome APIs

Uome's catalogue API provides a centralized solution for storing product items and prices, enabling easy checkout and billing generation for clients. The API allows users to store comprehensive information about their products, including item name, description, image, price, and other relevant details. This information is accessible to clients during checkout, streamlining the purchasing

Explore Uome's Catalogue API, the central solution for seamless checkout and billing. Store product details, prices, and images efficiently. Organise items into categories to enhance the shopping experience and optimize inventory management.

Catalogue | Uome APIs

Uome's ledger API enables users to settle and cancel transactions across the Uome ecosystem. The API provides a secure and efficient way for users to manage their financial transactions, allowing them to settle debts and cancel unnecessary transactions with ease.

Discover Uome's Ledger API, empowering users to settle and cancel transactions securely across the Uome ecosystem. Efficiently manage financial transactions, effortlessly settle debts, and cancel transactions with ease.

Ledger | Uome APIs

The Financial Statements API in Uome allows users to access and generate reports based on data within the Uome ecosystem. These reports can provide insights into areas such as financial transactions, user behavior, and business performance. By using this API, users can easily access and analyze the data they need to make informed decisions and improve their operations. The reports generated ca

Utilise Uome's Statements API to access and generate insightful reports within the Uome ecosystem. Analyse financial transactions, user behavior, and business performance for informed decisions. Tailor and export reports in diverse formats for comprehensive analysis and sharing.

Statements | Uome APIs

Uome's expenses API allows users to store and track their expenses in a ledger. The API provides a secure and convenient way to track expenses, allowing users to keep a record of their financial transactions and manage their budget efficiently.

Discover Uome's Expenses API, a secure solution for storing and tracking expenses. Effortlessly manage financial transactions, maintain expense records, and enhance budget management with this user-friendly API.

Expenses | Uome APIs

Uome's VAT API is a powerful tool that offers businesses a seamless solution for calculating and generating VAT returns in accordance with the specifications set by HMRC (Her Majesty's Revenue and Customs). By integrating this API into their systems, businesses can automate the entire process of creating and submitting VAT returns, saving valuable time and effort. The API leverages U

Explore Uome's VAT API, offering businesses a seamless solution for automating VAT calculations and returns. Leverage advanced algorithms for accurate VAT computation, compliance with tax regulations, and efficient tax reporting.

VAT | Uome APIs

The Sales Tax API is a robust tool designed for businesses to effortlessly manage and calculate sales tax across various jurisdictions. This API, when integrated into business systems, enables the automation of sales tax computation, ensuring accuracy and compliance with up-to-date regulations.Utilising cutting-edge technology, the Sales

Explore Uome's Sales Tax API, offering businesses a seamless solution for automating tax calculations and returns. Leverage advanced algorithms for accurate computation, compliance with tax regulations, and efficient tax reporting.

Sales Tax | Uome APIs

Stripe simplifies the payment process for customers, minimizing friction and enhancing the ease with which they can finalize their purchases. Moreover, Stripe provides a variety of sophisticated anti-fraud and security functionalities, which aid in safeguarding businesses and their patrons against deceitful activities.

Discover the seamless integration of Stripe within Uome, enhancing the payment process for customers. Benefit from anti-fraud measures and security features while accepting credit/debit cards, offering financing options, and incorporating Apple Pay and Google Pay.

Stripe Integration | Uome APIs

In order to use open banking services provided, a Know Your Customer (KYC) and Know Your Business (KYB) check must be completed for each user. These checks are a standard process that involves verifying the user's identity and business information to comply with anti-money laundering (AML) regulations. Until this check is completed, Uome, the platform that integrates, will restrict any us

Discover Uome's Open Banking Services, offering secure and compliant access to financial features through identity verification. Ensure trustworthy interactions with financial data and compliance with regulations.

Open Banking | Uome APIs

Ensure your business remains fortified against financial crime with our sanction list, a powerful Anti-Money Laundering (AML) and Counter-Terrorist Financing (CTF) screening solution offered by Uome API. Our cutting-edge technology is designed to uncover, thwart, and interdict illicit financial activities.

Safeguard your business against financial crime using Uome's powerful AML and CTF screening solution. Utilize cutting-edge technology to detect and prevent illicit financial activities effectively.

AML Screening Solution | Uome APIs

Uome&apos;s error handling API provides a comprehensive solution for handling errors that may occur during the use of Uome&apos;s various APIs. This API utilizes RESTful principles for handling requests and responses, making it easily integratable with various types of applications. The API provides detailed information about errors that may occur, along with clear and concise responses for each type of error. This information is designed to help developers and users quickly identify and resolve issues, improving the overall experience and ensuring seamless operation. With Uome&apos;s error handling API, users can be confident that their applications will continue to function smoothly, even in the event of an error. The API provides a robust solution for error handling, reducing downtime and improving the reliability of Uome&apos;s APIs.

Discover Uome's Error Handling API, offering a comprehensive solution for managing errors across various Uome APIs. Utilize RESTful principles for seamless integration and quickly identify, resolve, and enhance the overall user experience.