processReceipt Method

Important: the technology fully supports the receipts issued in USA and France, other countries are currently supported in beta mode.

The method allows you to recognize the image of a receipt. The method loads the image, creates a processing task for the image with the specified parameters, and passes the task for processing.

Customize the following request URL according to your application processing location:


The image file is transmitted in the request body. See the list of supported input formats.

The result is returned in XML format. The elements and attributes of the resulting file are described in Output XML with Receipt Data.

For details on task cost please see billing terms.

For a step-by-step guide, see How to Recognize Receipts. The recommendations on preparing the input images can be found in Photographing and Scanning Receipts.


Parameter Is required Default value Description
country No "usa"

Specifies the country where the receipt was printed. This parameter can contain several names of countries separated with commas, for example "taiwan,china". The following values are supported:

  • uk
  • usa
  • australia
  • canada
  • japan
  • germany
  • italy
  • france
  • brazil
  • russia
  • china
  • korea
  • netherlands
  • spain
  • singapore
  • taiwan
  • turkey
  • poland

Important! The technology fully supports the receipts from USA and France, other countries are currently supported in beta mode.

imageSource No "auto"

Specifies the source of the image. It can be either a scanned image, or a photograph created with a digital camera. Special preprocessing operations can be performed with the image depending on the selected source. For example, the system can automatically correct distorted text lines, poor focus and lighting on photos.

The value of this parameter can be one of the following:

  • auto
    The image source is detected automatically.
  • photo
  • scanner
correctOrientation No "true" Specifies whether the orientation of the image should be automatically detected and corrected. It can have one of the following values:
  • true
    The page orientation is automatically detected, and if it differs from normal the image is rotated.
  • false
    The page orientation detection and correction is not performed.
correctSkew No "true" Specifies whether the skew of the image should be automatically detected and corrected. It can have either true or false value.
xml:writeExtendedCharacterInfo No "false" Specifies whether the additional information on the recognized characters (e.g. whether the character is recognized uncertainly) should be written to an output file in XML format. The parameter can have one of the following values:
  • true
  • false
xml:fieldRegionExportMode No "doNotExport"

Specifies if the coordinates of field regions should be saved to the resulting XML file, and how the coordinates should be specified: on the original or on the corrected image. The parameter can have one of the following values:

  • doNotExport
  • forOriginalImage
  • forCorrectedImage
description No "" Contains the description of the processing task. Must contain no more than 255 characters.
pdfPassword No "" Contains a password for accessing password-protected images in PDF format.

Status codes and response format

General status codes and response format of the method are described in HTTP Status Codes and Response Formats.

Output file format

The result of processing is returned in an XML file of the following format:

<?xml version="1.0" encoding="UTF-8" ?>
<receipts count="1" xmlns="">
 <receipt currency="USD">
  <vendor confidence="73.71695592" isSuspicious="false">
     <text><![CDATA[175 RANCH DR]]></text>
   <phone confidence="100" isSuspicious="false">
   <purchaseType>General Retail</purchaseType>
   <city confidence="20" isSuspicious="true">
   <zip confidence="63" isSuspicious="true">
     <text>CA 95035</text>
   <administrativeRegion confidence="100" isSuspicious="false">
  <total confidence="67" isSuspicious="true">
    <text>PA 93</text>
  <tax total="false" rate="8.75">
    <text>8.750% 2 01</text>
  <payment type="Undefined" confidence="0" isSuspicious="true">
     <text>PA 93</text>
  <recognizedItems count="3">
   <item index="1">
    <name confidence="0" isSuspicious="true">
     <text>TOY BRD 4LB</text>
    <total confidence="43" isSuspicious="true">
    <recognizedText><![CDATA[0073052151457 TOY BRD 4LB 11.89
F&F Savings 2.10-
(RETURN PRICE 11.89 EA)]]></recognizedText>
    <sku confidence="51" isSuspicious="true">
    <amountUnits confidence="0" isSuspicious="true">Unknown</amountUnits>

See the XSD schema of an XML file.

Receipt languages

You do not need to set the recognition languages for receipt recognition; they will be selected automatically on the basis of the countries you specify. See below the list of languages corresponding to countries.

Country Languages
United Kingdom English
USA English
Japan Japanese; English
Germany German
Italy Italian; English
France French
Brazil Portuguese (Brazil); English
Russia Russian
China Chinese Simplified
Korea Korean; English
Spain Spanish; English
Taiwan Chinese Traditional
Netherlands Dutch
Australia English
Canada English; French

Malay; Chinese Simplified; English



Poland Polish

Note that the receipt in one of these languages, but printed in some other country, is not guaranteed to be recognized correctly.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request



Please sign in to leave a comment.