ReceiptUp

We use cookies to improve user experience and analyze website traffic. Read about how we use cookies and how you can control them by clicking "Privacy Preferences". Privacy Preferences I Agree Privacy Preferences When you visit any website, it may store or retrieve information through your browser, usually in the form of cookies. Since we respect your right to privacy, you can choose not to permit data collection from certain types of services. However, not allowing these services may impact your experience. Privacy Policy You read and agreed to our Privacy Policy REQUIRED CDN For performance and security reasons, we use Cloudflare as our CDN networks. REQUIRED Save Preferences Privacy Policy Receipt and invoice OCR API Convert receipt and invoice images into structured data. SIGN UP FREE DOCUMENTATION No Credit Card Required High Accuracy Experience the power of our OCR and AI technology for effortless receipt and invoice extraction, ensuring accuracy and efficiency in your financial operations. sign up > Multilingual OCR and AI Efficiently extract and process receipts and invoices from various languages and formats with Multilingual OCR and AI, streamlining financial workflows for businesses worldwide. sign up > Region Specific Data Simplify global financial data management with OCR and AI, offering precise receipt and invoice extraction capable of handling diverse sales tax types across multiple countries. sign up > Convert your receipts to structured data via our JSON REST API. Start for free today. No credit card required. Start For Free About Receipt OCR API Optimize your receipt management with our advanced Receipt OCR API. Transform receipts into actionable digital data with our Receipt OCR API, an advanced tool for precise data extraction. Our technology accurately extracts total amounts, taxes, dates, and merchant information from images of receipts and invoices. Ideal for various software systems, it streamlines data processing and enhances business analytics. Embrace efficient, accurate digitization of receipts and invoices with our state-of-the-art Optical Character Recognition technology, ensuring seamless integration and optimized data management. Sign Up Integrate Analyze { "uuid": "0c0ff8b9-92e7-4f10-a900-b2107af10ab7", "status": { "stage": "Completed", "description": "File processed successfully." }, "result": { "receipt_date": "2021-07-01 12:00:00", "receipt_id": null, "merchant_tax_payer_id": null, "merchant_tax_payer_type": null, "recipient_tax_payer_id": null, "recipient_tax_payer_type": null, "customer_number": null, "account_number": null, "currency_code": "GBP", "merchant": { "name": "TESCO", "address": "ADDLESTONE", "city": null, "state": null, "country_code": null, "postal_code": null, "phone_number": "0345 6778999" }, "recipient": { "name": null, "address": null, "city": null, "state": null, "country_code": null, "postal_code": null, "phone_number": null }, "order_date": null, "due_date": null, "delivery_date": null, "po_number": null, "total": 54.73, "amount_due": null, "amount_paid": null, "subtotal": null, "tax": null, "service_charge": null, "gratuity": null, "prior_balance": null, "discount": null, "shipping_charge": null, "line_items": [ { "item": "BS 4 WHT BAPS", "qty": 1, "price": 0.6, "unit_price": 0.6, "sku": null }, { "item": "GOV BAG CHARGE+*", "qty": 1, "price": 0.05, "unit_price": 0.05, "sku": null }, { "item": "GOV BAG CHARGE+*", "qty": 1, "price": 0.05, "unit_price": 0.05, "sku": null }, { "item": "BABYLEAF SALAD", "qty": 1, "price": 0.79, "unit_price": 0.79, "sku": null }, { "item": "TOMATOES", "qty": 1, "price": 0.9, "unit_price": 0.9, "sku": null }, { "item": "MOZZARELLA", "qty": 1, "price": 2.5, "unit_price": 2.5, "sku": null }, { "item": "SOREEN", "qty": 1, "price": 1.25, "unit_price": 1.25, "sku": null }, { "item": "ASPARAGUS", "qty": 1, "price": 1.5, "unit_price": 1.5, "sku": null }, { "item": "DIP", "qty": 1, "price": 1.5, "unit_price": 1.5, "sku": null }, { "item": "H/ROAST HAM", "qty": 1, "price": 4.17, "unit_price": 4.17, "sku": null }, { "item": "EGGS", "qty": 1, "price": 0.89, "unit_price": 0.89, "sku": null }, { "item": "PRAWN C.TAIL", "qty": 1, "price": 2, "unit_price": 2, "sku": null }, { "item": "RIPE AVOCADO", "qty": 1, "price": 1, "unit_price": 1, "sku": null }, { "item": "PROVENCE WINE *", "qty": 1, "price": 6, "unit_price": 6, "sku": null }, { "item": "CHOC. ORANGE *", "qty": 1, "price": 1, "unit_price": 1, "sku": null }, { "item": "CHOC DESSERT", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "CHOC DESSERT", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "READY MEAL", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "POTATO", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "STEAK", "qty": 1, "price": 6, "unit_price": 6, "sku": null }, { "item": "STEAK", "qty": 1, "price": 6, "unit_price": 6, "sku": null }, { "item": "MAILLE SAUCE", "qty": 1, "price": 1.53, "unit_price": 1.53, "sku": null }, { "item": "OTEX *", "qty": 1, "price": 5, "unit_price": 5, "sku": null } ] } } Key Features Multilingual Support for over 50 languages. Highly accurate Utilize the best OCR and AI tech for accurate data. Multiple formats Most image formats and PDFs supported. Accounting downloads Download your data to popular accounting file types. Affordable The most affordable receipt OCR & AI API. Try for free Sign up for a free account before you commit to a subscription. { "uuid": "6a751ac0-fa61-4b73-b141-5147aad500b4", "status": { "stage": "Completed", "description": "File processed successfully." }, "result": { "receipt_date": "2024-01-16 19:32:00", "receipt_id": "102426499866861650000", "merchant_tax_payer_id": null, "merchant_tax_payer_type": null, "recipient_tax_payer_id": null, "recipient_tax_payer_type": null, "customer_number": null, "account_number": null, "currency_code": "GBP", "merchant": { "name": "RECEIPTUP", "address": "132 HEREFORD DRIVE", "city": null, "state": null, "country_code": null, "postal_code": null, "phone_number": null }, "recipient": { "name": null, "address": null, "city": null, "state": null, "country_code": null, "postal_code": null, "phone_number": null }, "order_date": null, "due_date": null, "delivery_date": null, "po_number": null, "total": 14.4, "amount_due": null, "amount_paid": null, "subtotal": 12, "tax": 2.4, "service_charge": null, "gratuity": null, "prior_balance": null, "discount": null, "shipping_charge": null, "line_items": [ { "item": "BREAD", "qty": 1, "price": 2, "unit_price": null, "sku": "050656196046" }, { "item": "ORANGE JUICE", "qty": 1, "price": 3, "unit_price": null, "sku": "021158836138" }, { "item": "CUPCAKES", "qty": 1, "price": 4, "unit_price": null, "sku": "045700935215" }, { "item": "CEREAL", "qty": 1, "price": 3, "unit_price": null, "sku": "098858665224" } ] } } { "uuid": "6a751ac0-fa61-4b73-b141-5147aad500b4", "status": { "stage": "Completed", "description": "File processed successfully." }, "result": { "receipt_date": "2024-01-16 19:32:00", "receipt_id": "102426499866861650000", "merchant_tax_payer_id": null, "merchant_tax_payer_type": null, "recipient_tax_payer_id": null, "recipient_tax_payer_type": null, "customer_number": null, "account_number": null, "currency_code": "GBP", "merchant": { "name": "RECEIPTUP", "address": "132 HEREFORD DRIVE", "city": null, "state": null, "country_code": null, "postal_code": null, "phone_number": null }, "recipient": { "name": null, "address": null, "city": null, "state": null, "country_code": null, "postal_code": null, "phone_number": null }, "order_date": null, "due_date": null, "delivery_date": null, "po_number": null, "total": 14.4, "amount_due": null, "amount_paid": null, "subtotal": 12, "tax": 2.4, "service_charge": null, "gratuity": null, "prior_balance": null, "discount": null, "shipping_charge": null, "line_items": [ { "item": "BREAD", "qty": 1, "price": 2, "unit_price": null, "sku": "050656196046" }, { "item": "ORANGE JUICE", "qty": 1, "price": 3, "unit_price": null, "sku": "021158836138" }, { "item": "CUPCAKES", "qty": 1, "price": 4, "unit_price": null, "sku": "045700935215" }, { "item": "CEREAL", "qty": 1, "price": 3, "unit_price": null, "sku": "098858665224" } ] } } { "uuid": "6a751ac0-fa61-4b73-b141-5147aad500b4", "status": { "stage": "Completed", "description": "File processed successfully." }, "result": { "receipt_date": "2024-01-16 19:32:00", "receipt_id": "102426499866861650000", "merchant_tax_payer_id": null, "merchant_tax_payer_type": null, "recipient_tax_payer_id": null, "recipient_tax_payer_type": null, "customer_number": null, "account_number": null, "currency_code": "GBP", "merchant": { "name": "RECEIPTUP", "address": "132 HEREFORD DRIVE", "city": null, "state": null, "country_code": null, "postal_code": null, "phone_number": null }, "recipient": { "name": null, "address": null, "city": null, "state": null, "country_code": null, "postal_code": null, "phone_number": null }, "order_date": null, "due_date": null, "delivery_date": null, "po_number": null, "total": 14.4, "amount_due": null, "amount_paid": null, "subtotal": 12, "tax": 2.4, "service_charge": null, "gratuity": null, "prior_balance": null, "discount": null, "shipping_charge": null, "line_items": [ { "item": "BREAD", "qty": 1, "price": 2, "unit_price": null, "sku": "050656196046" }, { "item": "ORANGE JUICE", "qty": 1, "price": 3, "unit_price": null, "sku": "021158836138" }, { "item": "CUPCAKES", "qty": 1, "price": 4, "unit_price": null, "sku": "045700935215" }, { "item": "CEREAL", "qty": 1, "price": 3, "unit_price": null, "sku": "098858665224" } ] } } How it works Leverage our advanced OCR and AI technology for efficient receipt and invoice data extraction. Our three-step process is both streamlined and effective. First, users upload their receipt or invoice images via our intuitive API, designed for easy access and maximum efficiency. Next, we use state-of-the-art OCR technology to accurately extract text from these receipts. This advanced OCR system guarantees both speed and accuracy in text recognition across various receipt formats. Finally, our sophisticated AI algorithms come into play in the third step. They expertly analyze the extracted text to identify and extract key entities. This AI then organizes the information into a structured JSON response, simplifying integration into diverse data systems. 01 First Step Upload your receipt or invoice image with our easy-to-use and intuitive API. 02 Second Step We utilize industry leading OCR technology to extract the receipt text. 03 Third Step AI technology retrieves entities from the receipt text into a JSON response. FAQ's 1 - What do you provide? We provide REST API endpoints for processing photos, scans and digital copies of receipts and invoices into structured data. This makes integration of receipt processing into your project extremely fast and simple. 2 - Why choose us? We provide free access for you to use and test our API. Our API provides easy access to some of the best OCR and AI tech to process your images. 3 - Do I have to pay? Our service is 100% free to use while on our free plan. 4 - What counts as an API request? Each time the API is used to scan a receipt or invoice image, 1 API scan is added to your monthly usage. The number of scans allowed for your account depends on which subscription plan you are on. Retrieving your old scans does not incur additional request usage. 5 - Can I pay annually? Yes, paying annually will provide you 2 months free per year (18% discount). To register for a yearly plan, simply go to our pricing page and select an annual plan. SEE ALL FAQS --- We use cookies to improve user experience and analyze website traffic. Read about how we use cookies and how you can control them by clicking "Privacy Preferences". Privacy Preferences I Agree Privacy Preferences When you visit any website, it may store or retrieve information through your browser, usually in the form of cookies. Since we respect your right to privacy, you can choose not to permit data collection from certain types of services. However, not allowing these services may impact your experience. Privacy Policy You read and agreed to our Privacy Policy REQUIRED CDN For performance and security reasons, we use Cloudflare as our CDN networks. REQUIRED Save Preferences Privacy Policy ReceiptUp Subscriptions Monthly Yearly 18% discount Free $ 0.00 /mo $0.00/mo if billed annually 10 scans monthly Technical support Commercial use Cancel anytime Sign up Basic $ 39.00 /mo $33.00/mo if billed annually 1,000 scans monthly Technical support Commercial use Cancel anytime SIGN UP Standard $ 79.00 /mo $66.00/mo if billed annually 2,500 scans monthly Technical support Commercial use Cancel anytime SIGN UP POPULAR Pro $ 149.00 /mo $124.00/mo if billed annually 5,000 scans monthly Technical support Commercial use Cancel anytime SIGN UP Pro 10K $ 299.00 /mo $249.00/mo if billed annually 10,000 scans monthly Technical support Commercial use Cancel anytime SIGN UP Pro 20K $ 599.00 /mo $499.00/mo if billed annually 20,000 scans monthly Technical support Commercial use Cancel anytime SIGN UP Free $ 0.00 /mo $0.00/mo if billed monthly 10 requests monthly Access all endpoints Technical support Sign up Basic $ 33.00 /mo $39.00/mo if billed monthly 1,000 requests monthly Access all endpoints Technical support Commercial use SIGN UP Standard $ 66.00 /mo $79.00/mo if billed monthly 2,500 requests monthly Access all endpoints Technical support Commercial use SIGN UP POPULAR Pro $ 124.00 /mo $149.00/mo if billed monthly 5,000 requests monthly Access all endpoints Technical support Commercial use SIGN UP Pro 10K $ 249.00 /mo $299.00/mo if billed monthly 10,000 requests monthly Access all endpoints Technical support Commercial use SIGN UP Pro 20K $ 499.00 /mo $599.00/mo if billed monthly 20,000 requests monthly Access all endpoints Technical support Commercial use SIGN UP Need a custom solution? If none of the above plans are suitable for your needs, let us know. We would be more than happy to help create a custom solution for you. Some of the customizations we offer include: Custom monthly requests Custom data attributes for scans Custom SLA CUSTOM PLAN Request Quote --- We use cookies to improve user experience and analyze website traffic. Read about how we use cookies and how you can control them by clicking "Privacy Preferences". Privacy Preferences I Agree Privacy Preferences When you visit any website, it may store or retrieve information through your browser, usually in the form of cookies. Since we respect your right to privacy, you can choose not to permit data collection from certain types of services. However, not allowing these services may impact your experience. Privacy Policy You read and agreed to our Privacy Policy REQUIRED CDN For performance and security reasons, we use Cloudflare as our CDN networks. REQUIRED Save Preferences Privacy Policy Privacy Policy PRIVACY NOTICE Last updated October 28, 2023 Thank you for choosing to be part of our community at ReceiptUp ("company", "we", "us", "our"). We are committed to protecting your personal information and your right to privacy. If you have any questions or concerns about our policy, or our practices with regards to your personal information, please contact us at support@receiptup.com. When you visit our website https://www.receiptup.com, and use our services, you trust us with your personal information. We take your privacy very seriously. In this privacy notice, we describe our privacy policy. We seek to explain to you in the clearest way possible what information we collect, how we use it and what rights you have in relation to it. We hope you take some time to read through it carefully, as it is important. If there are any terms in this privacy policy that you do not agree with, please discontinue use of our Sites and our services. This privacy policy applies to all information collected through our website (such as https://www.receiptup.com), and/or any related services, sales, marketing or events (we refer to them collectively in this privacy policy as the "Sites"). Please read this privacy policy carefully as it will help you make informed decisions about sharing your personal information with us. TABLE OF CONTENTS 1. WHAT INFORMATION DO WE COLLECT? 2. HOW DO WE USE YOUR INFORMATION? 3. WILL YOUR INFORMATION BE SHARED WITH ANYONE? 4. WHO WILL YOUR INFORMATION BE SHARED WITH? 5. DO WE USE COOKIES AND OTHER TRACKING TECHNOLOGIES? 6. HOW LONG DO WE KEEP YOUR INFORMATION? 7. HOW DO WE KEEP YOUR INFORMATION SAFE? 8. DO WE COLLECT INFORMATION FROM MINORS? 9. WHAT ARE YOUR PRIVACY RIGHTS? 10. CONTROLS FOR DO-NOT-TRACK FEATURES 11. DO CALIFORNIA RESIDENTS HAVE SPECIFIC PRIVACY RIGHTS? 12. DO WE MAKE UPDATES TO THIS NOTICE? 13. HOW CAN YOU CONTACT US ABOUT THIS NOTICE? 1. WHAT INFORMATION DO WE COLLECT? Personal information you disclose to us In Short:  We collect personal information that you provide to us such as name, address, contact information, passwords and security data, and payment information. We collect personal information that you voluntarily provide to us when registering at the Sites expressing an interest in obtaining information about us or our products and services, when participating in activities on the Sites or otherwise contacting us. The personal information that we collect depends on the context of your interactions with us and the Sites, the choices you make and the products and features you use. The personal information we collect may include the following: Name and Contact Data.  We collect your first and last name, email address, postal address, phone number, and other similar contact data. Credentials.  We collect passwords, password hints, and similar security information used for authentication and account access. Payment Data. We collect data necessary to process your payment if you make purchases, such as your payment instrument number (such as a credit card number), and the security code associated with your payment instrument. All payment data is stored by our payment processor and you should review its privacy policies and contact the payment processor directly to respond to your questions. All personal information that you provide to us must be true, complete and accurate, and you must notify us of any changes to such personal information. Information automatically collected In Short:  Some information — such as IP address and/or browser and device characteristics — is collected automatically when you visit our Sites. We automatically collect certain information when you visit, use or navigate the Sites. This information does not reveal your specific identity (like your name or contact information) but may include device and usage information, such as your IP address, browser and device characteristics, operating system, language preferences, referring URLs, device name, country, location, information about how and when you use our Sites and other technical information. This information is primarily needed to maintain the security and operation of our Sites, and for our internal analytics and reporting purposes. Like many businesses, we also collect information through cookies and similar technologies. Information collected from other sources In Short:  We may collect limited data from public databases, marketing partners, and other outside sources. We may obtain information about you from other sources, such as public databases, joint marketing partners, as well as from other third parties. Examples of the information we receive from other sources include: social media profile information; marketing leads and search results and links, including paid listings (such as sponsored links). 2. HOW DO WE USE YOUR INFORMATION? In Short:  We process your information for purposes based on legitimate business interests, the fulfillment of our contract with you, compliance with our legal obligations, and/or your consent. We use personal information collected via our Sites for a variety of business purposes described below. We process your personal information for these purposes in reliance on our legitimate business interests ("Business Purposes"), in order to enter into or perform a contract with you ("Contractual"), with your consent ("Consent"), and/or for compliance with our legal obligations ("Legal Reasons"). We indicate the specific processing grounds we rely on next to each purpose listed below. We use the information we collect or receive: To facilitate account creation and logon process. If you choose to link your account with us to a third party account (such as your Google or Facebook account), we use the information you allowed us to collect from those third parties to facilitate account creation and logon process. To send you marketing and promotional communications. We and/or our third party marketing partners may use the personal information you send to us for our marketing purposes, if this is in accordance with your marketing preferences. You can opt-out of our marketing emails at any time (see the "WHAT ARE YOUR PRIVACY RIGHTS" below). Fulfill and manage your orders. We may use your information to fulfill and manage your orders, payments, returns, and exchanges made through the Sites. To post testimonials. We post testimonials on our Sites that may contain personal information. Prior to posting a testimonial, we will obtain your consent to use your name and testimonial. If you wish to update, or delete your testimonial, please contact us at https://www.receiptup.com and be sure to include your name, testimonial location, and contact information. To enforce our terms, conditions and policies.To respond to legal requests and prevent harm. If we receive a subpoena or other legal request, we may need to inspect the data we hold to determine how to respond.For other Business Purposes. We may use your information for other Business Purposes, such as data analysis, identifying usage trends, determining the effectiveness of our promotional campaigns and to evaluate and improve our Sites, products, services, marketing and your experience.3. WILL YOUR INFORMATION BE SHARED WITH ANYONE?In Short:  We only share information with your consent, to comply with laws, to provide you with services, to protect your rights, or to fulfill business obligations.We may process or share your data that we hold based on the following legal basis:Consent: We may process your data if you have given us specific consent to use your personal information for a specific purpose.Legitimate Interests: We may process your data when it is reasonably necessary to achieve our legitimate business interests.Performance of a Contract: Where we have entered into a contract with you, we may process your personal information to fulfill the terms of our contract.Legal Obligations: We may disclose your information where we are legally required to do so in order to comply with applicable law, governmental requests, a judicial proceeding, court order, or legal process, such as in response to a court order or a subpoena (including in response to public authorities to meet national security or law enforcement requirements).Vital Interests: We may disclose your information where we believe it is necessary to investigate, prevent, or take action regarding potential violations of our policies, suspected fraud, situations involving potential threats to the safety of any person and illegal activities, or as evidence in litigation in which we are involved.More specifically, we may need to process your data or share your personal information in the following situations:Business Transfers. We may share or transfer your information in connection with, or during negotiations of, any merger, sale of company assets, financing, or acquisition of all or a portion of our business to another company.Vendors, Consultants and Other Third-Party Service Providers. We may share your data with third party vendors, service providers, contractors or agents who perform services for us or on our behalf and require access to such information to do that work. Examples include: payment processing, data analysis, email delivery, hosting services, customer service and marketing efforts. We may allow selected third parties to use tracking technology on the Sites, which will enable them to collect data about how you interact with the Sites over time. This information may be used to, among other things, analyze and track data, determine the popularity of certain content and better understand online activity. Unless described in this Policy, we do not share, sell, rent or trade any of your information with third parties for their promotional purposes. Business Partners. We may share your information with our business partners to offer you certain products, services or promotions. 4. WHO WILL YOUR INFORMATION BE SHARED WITH? In Short:  We only share information with the following third parties. We only share and disclose your information with the following third parties. We have categorised each party so that you may be easily understand the purpose of our data collection and processing practices. If we have processed your data based on your consent and you wish to revoke your consent, please contact us. Invoice and Billing Stripe Web and Mobile Analytics Google Analytics 5. DO WE USE COOKIES AND OTHER TRACKING TECHNOLOGIES? In Short:  We may use cookies and other tracking technologies to collect and store your information. We may use cookies and similar tracking technologies (like web beacons and pixels) to access or store information. Specific information about how we use such technologies and how you can refuse certain cookies is set out in our Cookie Policy. 6. HOW LONG DO WE KEEP YOUR INFORMATION? In Short:  We keep your information for as long as necessary to fulfill the purposes outlined in this privacy policy unless otherwise required by law. We will only keep your personal information for as long as it is necessary for the purposes set out in this privacy policy, unless a longer retention period is required or permitted by law (such as tax, accounting or other legal requirements). No purpose in this policy will require us keeping your personal information for longer than the period of time in which users have an account with us. When we have no ongoing legitimate business need to process your personal information, we will either delete or anonymize it, or, if this is not possible (for example, because your personal information has been stored in backup archives), then we will securely store your personal information and isolate it from any further processing until deletion is possible. 7. HOW DO WE KEEP YOUR INFORMATION SAFE? In Short:  We aim to protect your personal information through a system of organisational and technical security measures. We have implemented appropriate technical and organisational security measures designed to protect the security of any personal information we process. However, please also remember that we cannot guarantee that the internet itself is 100% secure. Although we will do our best to protect your personal information, transmission of personal information to and from our Sites is at your own risk. You should only access the services within a secure environment. 8. DO WE COLLECT INFORMATION FROM MINORS? In Short:  We do not knowingly collect data from or market to children under 18 years of age. We do not knowingly solicit data from or market to children under 18 years of age. By using the Sites, you represent that you are at least 18 or that you are the parent or guardian of such a minor and consent to such minor dependent’s use of the Sites. If we learn that personal information from users less than 18 years of age has been collected, we will deactivate the account and take reasonable measures to promptly delete such data from our records. If you become aware of any data we may have collected from children under age 18, please contact us at support@receiptup.com. 9. WHAT ARE YOUR PRIVACY RIGHTS? In Short:  In some regions, such as the European Economic Area, you have rights that allow you greater access to and control over your personal information. You may review, change, or terminate your account at any time. In some regions (like the European Economic Area), you have certain rights under applicable data protection laws. These may include the right (i) to request access and obtain a copy of your personal information, (ii) to request rectification or erasure; (iii) to restrict the processing of your personal information; and (iv) if applicable, to data portability. In certain circumstances, you may also have the right to object to the processing of your personal information. To make such a request, please use the contact details provided below. We will consider and act upon any request in accordance with applicable data protection laws. If we are relying on your consent to process your personal information, you have the right to withdraw your consent at any time. Please note however that this will not affect the lawfulness of the processing before its withdrawal. If you are a resident in the European Economic Area and you believe we are unlawfully processing your personal information, you also have the right to complain to your local data protection supervisory authority. You can find their contact details here: http://ec.europa.eu/justice/data-protection/bodies/authorities/index_en.htm. Account Information If you would at any time like to review or change the information in your account or terminate your account, you can: Log into your account settings and update your user account. Contact us using the contact information provided. Upon your request to terminate your account, we will deactivate or delete your account and information from our active databases. However, some information my be retained in our files to prevent fraud, troubleshoot problems, assist with any investigations, enforce our Terms of Use and/or comply with legal requirements. Cookies and similar technologies: Most Web browsers are set to accept cookies by default. If you prefer, you can usually choose to set your browser to remove cookies and to reject cookies. If you choose to remove cookies or reject cookies, this could affect certain features or services of our Sites. To opt-out of interest-based advertising by advertisers on our Sites visit http://www.aboutads.info/choices/. Opting out of email marketing: You can unsubscribe from our marketing email list at any time by clicking on the unsubscribe link in the emails that we send or by contacting us using the details provided below. You will then be removed from the marketing email list — however, we will still need to send you service-related emails that are necessary for the administration and use of your account. To otherwise opt-out, you may: Note your preferences when you register an account with the site. Access your account settings and update preferences. Contact us using the contact information provided. 10. CONTROLS FOR DO-NOT-TRACK FEATURES Most web browsers and some mobile operating systems and mobile applications include a Do-Not-Track ("DNT") feature or setting you can activate to signal your privacy preference not to have data about your online browsing activities monitored and collected. No uniform technology standard for recognizing and implementing DNT signals has been finalized. As such, we do not currently respond to DNT browser signals or any other mechanism that automatically communicates your choice not to be tracked online. If a standard for online tracking is adopted that we must follow in the future, we will inform you about that practice in a revised version of this Privacy Policy. 11. DO CALIFORNIA RESIDENTS HAVE SPECIFIC PRIVACY RIGHTS? In Short:  Yes, if you are a resident of California, you are granted specific rights regarding access to your personal information. California Civil Code Section 1798.83, also known as the "Shine The Light" law, permits our users who are California residents to request and obtain from us, once a year and free of charge, information about categories of personal information (if any) we disclosed to third parties for direct marketing purposes and the names and addresses of all third parties with which we shared personal information in the immediately preceding calendar year. If you are a California resident and would like to make such a request, please submit your request in writing to us using the contact information provided below. If you are under 18 years of age, reside in California, and have a registered account with the Sites, you have the right to request removal of unwanted data that you publicly post on the Sites. To request removal of such data, please contact us using the contact information provided below, and include the email address associated with your account and a statement that you reside in California. We will make sure the data is not publicly displayed on the Sites, but please be aware that the data may not be completely or comprehensively removed from all our systems. 12. DO WE MAKE UPDATES TO THIS POLICY? In Short:  Yes, we will update this policy as necessary to stay compliant with relevant laws. We may update this privacy policy from time to time. The updated version will be indicated by an updated "Revised" date and the updated version will be effective as soon as it is accessible. If we make material changes to this privacy policy, we may notify you either by prominently posting a notice of such changes or by directly sending you a notification. We encourage you to review this privacy policy frequently to be informed of how we are protecting your information. 13. HOW CAN YOU CONTACT US ABOUT THIS POLICY? If you have questions or comments about this policy, you may email us at support@receiptup.com. HOW CAN YOU REVIEW, UPDATE, OR DELETE THE DATA WE COLLECT FROM YOU? Based on the applicable laws of your country, you may have the right to request access to the personal information we collect from you, change that information, or delete it in some circumstances. To request to review, update, or delete your personal information, please visit: https://www.receiptup.com/account/dashboard. We will respond to your request within 30 days. --- We use cookies to improve user experience and analyze website traffic. Read about how we use cookies and how you can control them by clicking "Privacy Preferences". Privacy Preferences I Agree Privacy Preferences When you visit any website, it may store or retrieve information through your browser, usually in the form of cookies. Since we respect your right to privacy, you can choose not to permit data collection from certain types of services. However, not allowing these services may impact your experience. Privacy Policy You read and agreed to our Privacy Policy REQUIRED CDN For performance and security reasons, we use Cloudflare as our CDN networks. REQUIRED Save Preferences Privacy Policy Documentation Sign up for free! Get instant access to the API with your free API token. No billing details required! Sign up now Getting Started Introduction Authentication API Endpoints Live scans File Base64 Queue scans File Base64 Scan search & status Status Search Errors Errors Examples Code Examples Getting Started Introduction ReceiptUp was developed to provide accurate and affordable OCR and AI technology via an easy to use REST API to convert receipt and invoice images to structured data formats. To get started simply sign up and use your API token in any of the available API endpoints documented below for instant access. If you have any questions or concerns, feel free to contact us. Authentication As mentioned above, when you sign up for free you will find your API token on your dashboard. Simply add this to any of our API endpoints as a GET or POST parameter to gain access. Examples of how this is done can be found below. API Endpoints Live scans Use live endpoints to request and return the receipt/invoice data in the same request. File Endpoint POST https://api.receiptup.com/v1/scan/file HTTP/1.1 HTTP POST Parameters name required description api_token true Your API token which can be found on your account dashboard. file true The full path to your file. Max size: 25MB. Allowed types: jpeg,jpg,bmp,png,gif,svg,pdf include_line_items false Choose if you would like to include or exclude line items. Setting this to true can significantly increase processing time, especially on receipts/invoices with many line items. Default: true store_result false Choose if you would like to store the result when finished processing. This result is stored in our database and you can retrieve it later using the uuid in our scan status endpoint. Default: true Response Objects name description uuid The unique identifier for your scan. status.stage The stage of scan processing. One of: Uploaded, Processing, Completed, Failed status.description A description of the scan stage. result.receipt_date Date and time of the receipt. result.receipt_id Identifier for the receipt. result.merchant_tax_payer_id Tax payer ID of the merchant. result.merchant_tax_payer_type Type of tax payer for the merchant (one of: ABN, GST, PAN, VAT). result.recipient_tax_payer_id Tax payer ID of the recipient. result.recipient_tax_payer_type Type of tax payer for the recipient (one of: ABN, GST, PAN, VAT). result.customer_number Customer number associated with the transaction. result.account_number Account number associated with the transaction. result.currency_code Currency code for the transaction (e.g., 'GBP'). result.merchant Object containing details of the merchant. result.merchant.name Name of the merchant (e.g., 'TESCO'). result.merchant.address Address of the merchant. result.merchant.city City of the merchant. result.merchant.state State of the merchant. result.merchant.country_code Country code of the merchant. result.merchant.postal_code Postal code of the merchant. result.merchant.phone_number Phone number of the merchant. result.recipient Object containing details of the recipient. result.recipient.name Name of the recipient. result.recipient.address Address of the recipient. result.recipient.city City of the recipient. result.recipient.state State of the recipient. result.recipient.country_code Country code of the recipient. result.recipient.postal_code Postal code of the recipient. result.recipient.phone_number Phone number of the recipient. result.order_date Date of the order. result.due_date Due date for payment or delivery. result.delivery_date Date of delivery. result.po_number Purchase order number. result.total Total amount of the transaction. result.amount_due Amount due for the transaction. result.amount_paid Amount paid for the transaction. result.subtotal Subtotal amount before taxes and other charges. result.tax Tax amount for the transaction. result.service_charge Service charge for the transaction. result.gratuity Gratuity amount, if applicable. result.prior_balance Balance from previous transactions, if any. result.discount Discount applied, if any. result.shipping_charge Shipping charge for the transaction. result.line_items[Array].item Name of the item in the transaction. result.line_items[Array].qty Quantity of the item purchased. result.line_items[Array].price Price of the item. result.line_items[Array].unit_price Unit price of the item. result.line_items[Array].sku Stock Keeping Unit (SKU) identifier, if available. Example Request (cURL POST) curl --location 'https://api.receiptup.com/v1/scan/file' \ --form 'api_token="YOUR_API_TOKEN"' \ --form 'file=@"/path/to/your/file.jpg"' \ --form 'include_line_items="true"' \ --form 'store_result="true"' Example Response { "uuid": "0c0ff8b9-92e7-4f10-a900-b2107af10ab7", "status": { "stage": "Completed", "description": "File processed successfully." }, "result": { "receipt_date": "2021-07-01 12:00:00", "receipt_id": null, "merchant_tax_payer_id": null, "merchant_tax_payer_type": null, "recipient_tax_payer_id": null, "recipient_tax_payer_type": null, "customer_number": null, "account_number": null, "currency_code": "GBP", "merchant": { "name": "TESCO", "address": "ADDLESTONE", "city": null, "state": null, "country_code": null, "postal_code": null, "phone_number": "0345 6778999" }, "recipient": { "name": null, "address": null, "city": null, "state": null, "country_code": null, "postal_code": null, "phone_number": null }, "order_date": null, "due_date": null, "delivery_date": null, "po_number": null, "total": 54.73, "amount_due": null, "amount_paid": null, "subtotal": null, "tax": null, "service_charge": null, "gratuity": null, "prior_balance": null, "discount": null, "shipping_charge": null, "line_items": [ { "item": "BS 4 WHT BAPS", "qty": 1, "price": 0.6, "unit_price": 0.6, "sku": null }, { "item": "GOV BAG CHARGE+*", "qty": 1, "price": 0.05, "unit_price": 0.05, "sku": null }, { "item": "GOV BAG CHARGE+*", "qty": 1, "price": 0.05, "unit_price": 0.05, "sku": null }, { "item": "BABYLEAF SALAD", "qty": 1, "price": 0.79, "unit_price": 0.79, "sku": null }, { "item": "TOMATOES", "qty": 1, "price": 0.9, "unit_price": 0.9, "sku": null }, { "item": "MOZZARELLA", "qty": 1, "price": 2.5, "unit_price": 2.5, "sku": null }, { "item": "SOREEN", "qty": 1, "price": 1.25, "unit_price": 1.25, "sku": null }, { "item": "ASPARAGUS", "qty": 1, "price": 1.5, "unit_price": 1.5, "sku": null }, { "item": "DIP", "qty": 1, "price": 1.5, "unit_price": 1.5, "sku": null }, { "item": "H/ROAST HAM", "qty": 1, "price": 4.17, "unit_price": 4.17, "sku": null }, { "item": "EGGS", "qty": 1, "price": 0.89, "unit_price": 0.89, "sku": null }, { "item": "PRAWN C.TAIL", "qty": 1, "price": 2, "unit_price": 2, "sku": null }, { "item": "RIPE AVOCADO", "qty": 1, "price": 1, "unit_price": 1, "sku": null }, { "item": "PROVENCE WINE *", "qty": 1, "price": 6, "unit_price": 6, "sku": null }, { "item": "CHOC. ORANGE *", "qty": 1, "price": 1, "unit_price": 1, "sku": null }, { "item": "CHOC DESSERT", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "CHOC DESSERT", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "READY MEAL", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "POTATO", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "STEAK", "qty": 1, "price": 6, "unit_price": 6, "sku": null }, { "item": "STEAK", "qty": 1, "price": 6, "unit_price": 6, "sku": null }, { "item": "MAILLE SAUCE", "qty": 1, "price": 1.53, "unit_price": 1.53, "sku": null }, { "item": "OTEX *", "qty": 1, "price": 5, "unit_price": 5, "sku": null } ] } } Base64 Endpoint POST https://api.receiptup.com/v1/scan/base64 HTTP/1.1 HTTP POST Parameters name required description api_token true Your API token which can be found on your account dashboard. base64 true The base64 encoded version of your file. Max size: 25MB. Allowed types: jpeg,jpg,bmp,png,gif,svg,pdf include_line_items false Choose if you would like to include or exclude line items. Setting this to true can significantly increase processing time, especially on receipts/invoices with many line items. Default: true store_result false Choose if you would like to store the result when finished processing. This result is stored in our database and you can retrieve it later using the uuid in our scan status endpoint. Default: true Response Objects name description uuid The unique identifier for your scan. status.stage The stage of scan processing. One of: Uploaded, Processing, Completed, Failed status.description A description of the scan stage. result.receipt_date Date and time of the receipt. result.receipt_id Identifier for the receipt. result.merchant_tax_payer_id Tax payer ID of the merchant. result.merchant_tax_payer_type Type of tax payer for the merchant (one of: ABN, GST, PAN, VAT). result.recipient_tax_payer_id Tax payer ID of the recipient. result.recipient_tax_payer_type Type of tax payer for the recipient (one of: ABN, GST, PAN, VAT). result.customer_number Customer number associated with the transaction. result.account_number Account number associated with the transaction. result.currency_code Currency code for the transaction (e.g., 'GBP'). result.merchant Object containing details of the merchant. result.merchant.name Name of the merchant (e.g., 'TESCO'). result.merchant.address Address of the merchant. result.merchant.city City of the merchant. result.merchant.state State of the merchant. result.merchant.country_code Country code of the merchant. result.merchant.postal_code Postal code of the merchant. result.merchant.phone_number Phone number of the merchant. result.recipient Object containing details of the recipient. result.recipient.name Name of the recipient. result.recipient.address Address of the recipient. result.recipient.city City of the recipient. result.recipient.state State of the recipient. result.recipient.country_code Country code of the recipient. result.recipient.postal_code Postal code of the recipient. result.recipient.phone_number Phone number of the recipient. result.order_date Date of the order. result.due_date Due date for payment or delivery. result.delivery_date Date of delivery. result.po_number Purchase order number. result.total Total amount of the transaction. result.amount_due Amount due for the transaction. result.amount_paid Amount paid for the transaction. result.subtotal Subtotal amount before taxes and other charges. result.tax Tax amount for the transaction. result.service_charge Service charge for the transaction. result.gratuity Gratuity amount, if applicable. result.prior_balance Balance from previous transactions, if any. result.discount Discount applied, if any. result.shipping_charge Shipping charge for the transaction. result.line_items[Array].item Name of the item in the transaction. result.line_items[Array].qty Quantity of the item purchased. result.line_items[Array].price Price of the item. result.line_items[Array].unit_price Unit price of the item. result.line_items[Array].sku Stock Keeping Unit (SKU) identifier, if available. Example Request (cURL POST) curl --location 'https://api.receiptup.com/v1/scan/base64' \ --form 'api_token="YOUR_API_TOKEN"' \ --form 'base64="base64 encoded file"' \ --form 'include_line_items="true"' \ --form 'store_result="true"' Example Response { "uuid": "0c0ff8b9-92e7-4f10-a900-b2107af10ab7", "status": { "stage": "Completed", "description": "File processed successfully." }, "result": { "receipt_date": "2021-07-01 12:00:00", "receipt_id": null, "merchant_tax_payer_id": null, "merchant_tax_payer_type": null, "recipient_tax_payer_id": null, "recipient_tax_payer_type": null, "customer_number": null, "account_number": null, "currency_code": "GBP", "merchant": { "name": "TESCO", "address": "ADDLESTONE", "city": null, "state": null, "country_code": null, "postal_code": null, "phone_number": "0345 6778999" }, "recipient": { "name": null, "address": null, "city": null, "state": null, "country_code": null, "postal_code": null, "phone_number": null }, "order_date": null, "due_date": null, "delivery_date": null, "po_number": null, "total": 54.73, "amount_due": null, "amount_paid": null, "subtotal": null, "tax": null, "service_charge": null, "gratuity": null, "prior_balance": null, "discount": null, "shipping_charge": null, "line_items": [ { "item": "BS 4 WHT BAPS", "qty": 1, "price": 0.6, "unit_price": 0.6, "sku": null }, { "item": "GOV BAG CHARGE+*", "qty": 1, "price": 0.05, "unit_price": 0.05, "sku": null }, { "item": "GOV BAG CHARGE+*", "qty": 1, "price": 0.05, "unit_price": 0.05, "sku": null }, { "item": "BABYLEAF SALAD", "qty": 1, "price": 0.79, "unit_price": 0.79, "sku": null }, { "item": "TOMATOES", "qty": 1, "price": 0.9, "unit_price": 0.9, "sku": null }, { "item": "MOZZARELLA", "qty": 1, "price": 2.5, "unit_price": 2.5, "sku": null }, { "item": "SOREEN", "qty": 1, "price": 1.25, "unit_price": 1.25, "sku": null }, { "item": "ASPARAGUS", "qty": 1, "price": 1.5, "unit_price": 1.5, "sku": null }, { "item": "DIP", "qty": 1, "price": 1.5, "unit_price": 1.5, "sku": null }, { "item": "H/ROAST HAM", "qty": 1, "price": 4.17, "unit_price": 4.17, "sku": null }, { "item": "EGGS", "qty": 1, "price": 0.89, "unit_price": 0.89, "sku": null }, { "item": "PRAWN C.TAIL", "qty": 1, "price": 2, "unit_price": 2, "sku": null }, { "item": "RIPE AVOCADO", "qty": 1, "price": 1, "unit_price": 1, "sku": null }, { "item": "PROVENCE WINE *", "qty": 1, "price": 6, "unit_price": 6, "sku": null }, { "item": "CHOC. ORANGE *", "qty": 1, "price": 1, "unit_price": 1, "sku": null }, { "item": "CHOC DESSERT", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "CHOC DESSERT", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "READY MEAL", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "POTATO", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "STEAK", "qty": 1, "price": 6, "unit_price": 6, "sku": null }, { "item": "STEAK", "qty": 1, "price": 6, "unit_price": 6, "sku": null }, { "item": "MAILLE SAUCE", "qty": 1, "price": 1.53, "unit_price": 1.53, "sku": null }, { "item": "OTEX *", "qty": 1, "price": 5, "unit_price": 5, "sku": null } ] } } Queue scans Use queue endpoints to send your request to be processed in the background. You can retrieve the data later by passing the returned UUID to our scan status endpoint. File Endpoint POST https://api.receiptup.com/v1/scan/file/queue HTTP/1.1 HTTP POST Parameters name required description api_token true Your API token which can be found on your account dashboard. file true The full path to your file. Max size: 25MB. Allowed types: jpeg,jpg,bmp,png,gif,svg,pdf include_line_items false Choose if you would like to include or exclude line items. Setting this to true can significantly increase processing time, especially on receipts/invoices with many line items. Default: true Response Objects name description uuid The unique identifier for your scan. Example Request (cURL POST) curl --location 'https://api.receiptup.com/v1/scan/file/queue' \ --form 'api_token="YOUR_API_TOKEN"' \ --form 'file=@"/path/to/your/file.jpg"' \ --form 'include_line_items="true"' Example Response { "uuid": "d3754a04-6fa1-447d-831f-d654775bad9e" } Base64 Endpoint POST https://api.receiptup.com/v1/scan/base64/queue HTTP/1.1 HTTP POST Parameters name required description api_token true Your API token which can be found on your account dashboard. base64 true The base64 encoded version of your file. Max size: 25MB. Allowed types: jpeg,jpg,bmp,png,gif,svg,pdf include_line_items false Choose if you would like to include or exclude line items. Setting this to true can significantly increase processing time, especially on receipts/invoices with many line items. Default: true Response Objects name description uuid The unique identifier for your scan. Example Request (cURL POST) curl --location 'https://api.receiptup.com/v1/scan/base64/queue' \ --form 'api_token="YOUR_API_TOKEN"' \ --form 'base64="base64 encoded file"' \ --form 'include_line_items="true"' \ --form 'store_result="true"' Example Response { "uuid": "d3754a04-6fa1-447d-831f-d654775bad9e" } Scan status & search Scan status Use the scan status endpoint to retrieve the results or status for queued scans or results from previous live scans. Live scan results can only be retrieved from this endpoint when store_result is set to true when making a request to a live scan endpoint. Requests made to the scan status endpoint does not contribute to your number of monthly available scans. Requests can be made as either GET or POST methods. Endpoint GET https://api.receiptup.com/v1/scan/status HTTP/1.1 HTTP GET or POST Parameters name required description api_token true Your API token which can be found on your account dashboard. uuid true The UUID which was provided to you via our live or queued scan endpoints. Response Objects name description uuid The unique identifier for your scan. status.stage The stage of scan processing. One of: Uploaded, Processing, Completed, Failed status.description A description of the scan stage. result.receipt_date Date and time of the receipt. result.receipt_id Identifier for the receipt. result.merchant_tax_payer_id Tax payer ID of the merchant. result.merchant_tax_payer_type Type of tax payer for the merchant (one of: ABN, GST, PAN, VAT). result.recipient_tax_payer_id Tax payer ID of the recipient. result.recipient_tax_payer_type Type of tax payer for the recipient (one of: ABN, GST, PAN, VAT). result.customer_number Customer number associated with the transaction. result.account_number Account number associated with the transaction. result.currency_code Currency code for the transaction (e.g., 'GBP'). result.merchant Object containing details of the merchant. result.merchant.name Name of the merchant (e.g., 'TESCO'). result.merchant.address Address of the merchant. result.merchant.city City of the merchant. result.merchant.state State of the merchant. result.merchant.country_code Country code of the merchant. result.merchant.postal_code Postal code of the merchant. result.merchant.phone_number Phone number of the merchant. result.recipient Object containing details of the recipient. result.recipient.name Name of the recipient. result.recipient.address Address of the recipient. result.recipient.city City of the recipient. result.recipient.state State of the recipient. result.recipient.country_code Country code of the recipient. result.recipient.postal_code Postal code of the recipient. result.recipient.phone_number Phone number of the recipient. result.order_date Date of the order. result.due_date Due date for payment or delivery. result.delivery_date Date of delivery. result.po_number Purchase order number. result.total Total amount of the transaction. result.amount_due Amount due for the transaction. result.amount_paid Amount paid for the transaction. result.subtotal Subtotal amount before taxes and other charges. result.tax Tax amount for the transaction. result.service_charge Service charge for the transaction. result.gratuity Gratuity amount, if applicable. result.prior_balance Balance from previous transactions, if any. result.discount Discount applied, if any. result.shipping_charge Shipping charge for the transaction. result.line_items[Array].item Name of the item in the transaction. result.line_items[Array].qty Quantity of the item purchased. result.line_items[Array].price Price of the item. result.line_items[Array].unit_price Unit price of the item. result.line_items[Array].sku Stock Keeping Unit (SKU) identifier, if available. Example Request (cURL GET) curl --location 'https://api.receiptup.com/v1/scan/status?api_token=YOUR_API_TOKEN&uuid=43d17453-6ba3-4a8c-ad57-b2dfdf8d34e2' Example Response { "uuid": "0c0ff8b9-92e7-4f10-a900-b2107af10ab7", "status": { "stage": "Completed", "description": "File processed successfully." }, "result": { "receipt_date": "2021-07-01 12:00:00", "receipt_id": null, "merchant_tax_payer_id": null, "merchant_tax_payer_type": null, "recipient_tax_payer_id": null, "recipient_tax_payer_type": null, "customer_number": null, "account_number": null, "currency_code": "GBP", "merchant": { "name": "TESCO", "address": "ADDLESTONE", "city": null, "state": null, "country_code": null, "postal_code": null, "phone_number": "0345 6778999" }, "recipient": { "name": null, "address": null, "city": null, "state": null, "country_code": null, "postal_code": null, "phone_number": null }, "order_date": null, "due_date": null, "delivery_date": null, "po_number": null, "total": 54.73, "amount_due": null, "amount_paid": null, "subtotal": null, "tax": null, "service_charge": null, "gratuity": null, "prior_balance": null, "discount": null, "shipping_charge": null, "line_items": [ { "item": "BS 4 WHT BAPS", "qty": 1, "price": 0.6, "unit_price": 0.6, "sku": null }, { "item": "GOV BAG CHARGE+*", "qty": 1, "price": 0.05, "unit_price": 0.05, "sku": null }, { "item": "GOV BAG CHARGE+*", "qty": 1, "price": 0.05, "unit_price": 0.05, "sku": null }, { "item": "BABYLEAF SALAD", "qty": 1, "price": 0.79, "unit_price": 0.79, "sku": null }, { "item": "TOMATOES", "qty": 1, "price": 0.9, "unit_price": 0.9, "sku": null }, { "item": "MOZZARELLA", "qty": 1, "price": 2.5, "unit_price": 2.5, "sku": null }, { "item": "SOREEN", "qty": 1, "price": 1.25, "unit_price": 1.25, "sku": null }, { "item": "ASPARAGUS", "qty": 1, "price": 1.5, "unit_price": 1.5, "sku": null }, { "item": "DIP", "qty": 1, "price": 1.5, "unit_price": 1.5, "sku": null }, { "item": "H/ROAST HAM", "qty": 1, "price": 4.17, "unit_price": 4.17, "sku": null }, { "item": "EGGS", "qty": 1, "price": 0.89, "unit_price": 0.89, "sku": null }, { "item": "PRAWN C.TAIL", "qty": 1, "price": 2, "unit_price": 2, "sku": null }, { "item": "RIPE AVOCADO", "qty": 1, "price": 1, "unit_price": 1, "sku": null }, { "item": "PROVENCE WINE *", "qty": 1, "price": 6, "unit_price": 6, "sku": null }, { "item": "CHOC. ORANGE *", "qty": 1, "price": 1, "unit_price": 1, "sku": null }, { "item": "CHOC DESSERT", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "CHOC DESSERT", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "READY MEAL", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "POTATO", "qty": 1, "price": 3, "unit_price": 3, "sku": null }, { "item": "STEAK", "qty": 1, "price": 6, "unit_price": 6, "sku": null }, { "item": "STEAK", "qty": 1, "price": 6, "unit_price": 6, "sku": null }, { "item": "MAILLE SAUCE", "qty": 1, "price": 1.53, "unit_price": 1.53, "sku": null }, { "item": "OTEX *", "qty": 1, "price": 5, "unit_price": 5, "sku": null } ] } } Scan search Requests made to the scan search endpoint does not contribute to your number of monthly available scans. Requests can be made as either GET or POST methods. Endpoint GET https://api.receiptup.com/v1/scan/search HTTP/1.1 HTTP GET or POST Parameters name required description api_token true Your API token which can be found on your account dashboard. page false Paginate your scan results. Result limit is 20. Default page is 1. status false Refine results by the scan status. Valid values include completed, failed, processing, uploaded. All status values are included by default. show_result_attribute false Choose whether to include the result attribute in the data output. Default is true. Response Objects name description meta.current_page The current page of the pagination results, as defined by the page parameter. meta.results_per_page The number of results per page (the limit). meta.results_current_page The number of results on the current page. meta.results_total The total number of results. meta.results_last_page The last page of results (i.e. the max page). data[Array].uuid The unique identifier for the scan. data[Array].status.stage The stage of scan processing. Options include: Uploaded,Processing, Completed,Failed data[Array].status.description A description of the scan stage. data[Array].queued Whether the scan was queued, true/false. If false the scan was a live scan. data[Array].is_base_64 Whether the scan was made as a base64 scan, true/falase. data[Array].store_result Whether the result was stored. data[Array].include_list_items Whether the scan was requested to include line items in the result. data[Array].result The result of a scan. See live scan response object for example. Null if empty. Example Request (cURL GET) curl --location 'https://api.receiptup.com/v1/scan/search?api_token=YOUR_API_TOKEN' Example Response { "meta": { "current_page": 1, "results_per_page": 10, "results_current_page": 10, "results_total": 36, "results_last_page": 4 }, "data": [ { "uuid": "a2596e01-b9a4-4c48-92a2-34d3ff22f6cf", "status": { "stage": "Uploaded", "description": "File uploaded, pending processing." }, "queued": false, "is_base_64": true, "store_result": false, "include_list_items": true, "result": null }, { "uuid": "439c0f08-8351-4017-bb8c-1b0ae033dae4", "status": { "stage": "Completed", "description": "File processed successfully." }, "queued": true, "is_base_64": true, "store_result": false, "include_list_items": true, "result": null }, { "uuid": "3868f779-d645-442e-aa66-c763cac94473", "status": { "stage": "Uploaded", "description": "File uploaded, pending processing." }, "queued": false, "is_base_64": false, "store_result": false, "include_list_items": true, "result": null }, { "uuid": "6bdb2ebc-fc99-43fa-bbf7-90c8b01eaaf2", "status": { "stage": "Uploaded", "description": "File uploaded, pending processing." }, "queued": false, "is_base_64": false, "store_result": false, "include_list_items": true, "result": null }, { "uuid": "600e7f50-c348-4ead-a63a-d59abd5c5c71", "status": { "stage": "Uploaded", "description": "File uploaded, pending processing." }, "queued": false, "is_base_64": false, "store_result": false, "include_list_items": true, "result": null }, { "uuid": "971cb9f3-7b22-450c-8c15-36deb37168d7", "status": { "stage": "Uploaded", "description": "File uploaded, pending processing." }, "queued": false, "is_base_64": false, "store_result": false, "include_list_items": true, "result": null }, { "uuid": "d3754a04-6fa1-447d-831f-d654775bad9e", "status": { "stage": "Uploaded", "description": "File uploaded, pending processing." }, "queued": false, "is_base_64": true, "store_result": false, "include_list_items": true, "result": null }, { "uuid": "5584c81f-806f-4afb-9179-b12aea96d6f7", "status": { "stage": "Completed", "description": "File processed successfully." }, "queued": true, "is_base_64": true, "store_result": false, "include_list_items": true, "result": null }, { "uuid": "3cd03e37-919e-4d25-bc3e-79490df174b0", "status": { "stage": "Completed", "description": "File processed successfully." }, "queued": true, "is_base_64": false, "store_result": true, "include_list_items": true, "result": null }, { "uuid": "0dcb62b5-0417-4eb5-a0b0-c50b42108a80", "status": { "stage": "Uploaded", "description": "File uploaded, pending processing." }, "queued": false, "is_base_64": false, "store_result": false, "include_list_items": true, "result": null } ] } Errors Errors If your request was unsuccessful, you will receive a JSON formatted error. Below you will find the potential errors you may encounter when using the API. Errors error code HTTP status description malformed_parameters 400 Validation of parameters failed. The failed parameters are usually shown in the error message. invalid_api_token 401 Invalid API token. usage_limit_reached 402 Usage limit of your plan has been reached. Usage limit and remaining requests can be found on the X-UsageLimit-Limit header. endpoint_access_restricted 403 Access to the endpoint is not available on your current subscription plan. resource_not_found 404 Resource could not be found. invalid_api_endpoint 404 API route does not exist. method_not_allowed 405 HTTP Method is not allowed (GET, POST). rate_limit_reached 429 Too many requests in the past 60 seconds. Rate limit and remaining requests can be found on the X-RateLimit-Limit header. server_error 500 A server error occured. maintenance_mode 503 The service is currently under maintenance. Example Error Response { "error": { "code": "malformed_parameters", "message": "The file parameter(s) are incorrectly formatted." } } Examples Code Examples See our prepared examples below to quickly get started implementing our API into your next project. PHP $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://api.receiptup.com/v1/scan/file', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS =>'{ "api_token": "YOUR_API_TOKEN", "file": "/path/to/your/file.png", "include_line_items": "true", "store_result": "true" }', CURLOPT_HTTPHEADER => array( 'Content-Type: application/json' ), )); $response = curl_exec($curl); curl_close($curl); echo $response; Python import requests url = "https://api.receiptup.com/v1/scan/file" payload = {'api_token': 'YOUR_API_TOKEN', 'include_line_items': 'true', 'store_result': 'true'} files=[ ('file',('file.png',open('/path/to/your/file.png','rb'),'image/png')) ] headers = {} response = requests.request("POST", url, headers=headers, data=payload, files=files) print(response.text) Go package main import ( "fmt" "bytes" "mime/multipart" "os" "path/filepath" "io" "net/http" "io/ioutil" ) func main() { url := "https://api.receiptup.com/v1/scan/file" method := "POST" payload := &bytes.Buffer{} writer := multipart.NewWriter(payload) _ = writer.WriteField("api_token", "YOUR_API_TOKEN") file, errFile2 := os.Open("/path/to/your/file.png") defer file.Close() part2, errFile2 := writer.CreateFormFile("file",filepath.Base("/path/to/your/file.png")) _, errFile2 = io.Copy(part2, file) if errFile2 != nil { fmt.Println(errFile2) return } _ = writer.WriteField("include_line_items", "true") _ = writer.WriteField("store_result", "true") err := writer.Close() if err != nil { fmt.Println(err) return } client := &http.Client { } req, err := http.NewRequest(method, url, payload) if err != nil { fmt.Println(err) return } req.Header.Set("Content-Type", writer.FormDataContentType()) res, err := client.Do(req) if err != nil { fmt.Println(err) return } defer res.Body.Close() body, err := ioutil.ReadAll(res.Body) if err != nil { fmt.Println(err) return } fmt.Println(string(body)) } JavaScript // WARNING: For POST requests, body is set to null by browsers. var data = new FormData(); data.append("api_token", "YOUR_API_TOKEN"); data.append("file", fileInput.files[0], "file.png"); data.append("include_line_items", "true"); data.append("store_result", "true"); var xhr = new XMLHttpRequest(); xhr.withCredentials = true; xhr.addEventListener("readystatechange", function() { if(this.readyState === 4) { console.log(this.responseText); } }); xhr.open("POST", "https://api.receiptup.com/v1/scan/file"); xhr.send(data); C# var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://api.receiptup.com/v1/scan/file"); var content = new MultipartFormDataContent(); content.Add(new StringContent("YOUR_API_TOKEN"), "api_token"); content.Add(new StreamContent(File.OpenRead("/path/to/your/file.png")), "file", "/path/to/your/file.png"); content.Add(new StringContent("true"), "include_line_items"); content.Add(new StringContent("true"), "store_result"); request.Content = content; var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync()); Java OkHttpClient client = new OkHttpClient().newBuilder().build(); MediaType mediaType = MediaType.parse("text/plain"); RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM) .addFormDataPart("api_token","YOUR_API_TOKEN") .addFormDataPart("file","file.png", RequestBody.create(MediaType.parse("application/octet-stream"), new File("/path/to/your/file.png"))) .addFormDataPart("include_line_items","true") .addFormDataPart("store_result","true") .build(); Request request = new Request.Builder() .url("https://api.receiptup.com/v1/scan/file") .method("POST", body) .build(); Response response = client.newCall(request).execute();