v3

latestSwagger 2.02026-08-0125316174.5 KB

2. Try other input format endpoints

transcribe a receipt from URL

post/api/receipt/v1/simple/url

Headers

apikeystring required

API authentication key.

Request body

urlstring required

The target URL that contains a receipt file. Only https protocol is accepted.

refreshboolean

Set true to force re-process image transcription if the receipt is already in storage

incognitoboolean

Set true to avoid saving the receipt in storage

ipAddressstring

IP Address of the end user

nearstring

A geo location to search for merchant. Typically in the format of city, state, country.

ignoreMerchantNamestring

Ignore this merchant name if detected on the receipt. Use this field to avoid detecting the customer name as the merchant name.

language'en' | 'es' | 'fr' | 'jp' | 'he' | 'iw' | 'et' | 'lv' | 'lt' | 'fi' | 'el' | 'zh' | 'th' | 'ar' | 'kh'

Set language as a hint. Leave empty for auto detect. Supported languages: , en, es, fr, jp, he, iw, et, lv, lt, fi, el, zh, th, ar, kh

extractTimeboolean

Set true to return time if found on the receipt. Otherwise, the time is always set to 12:00:00.000.

subAccountIdstring

Tag a request with sub-account ID for billing purposes

referenceIdstring

Tag a request with a unique reference ID for feedback/training and receipt similarity check purposes

userIdstring

Tag a request with a user ID so that duplicate receipts by the same user can be detected

containerIdstring

Tag a request with a container ID for fraud detection purposes

Example request

{
  "url": "https://files.readme.io/57ca9b1717a5dbdd7f56a913f47d2f758ffedaa08375dc5ac31d6fe76c4d3d32-example-taggun-receipt.png",
  "ipAddress": "32.4.2.223",
  "near": "Kalamazoo, MI, USA"
}

Response

Success