transcribe a receipt from URL

POST

/api/receipt/v1/simple/url

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠400Bad Request

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.taggun.io//api/receipt/v1/simple/url' \
--header 'apikey;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "extractTime": false,
    "headers": {
        "x-custom-key": "string"
    },
    "ignoreMerchantName": "string",
    "incognito": false,
    "ipAddress": "32.4.2.223",
    "language": "en",
    "near": "Kalamazoo, MI, USA",
    "referenceId": "string",
    "refresh": false,
    "subAccountId": "string",
    "url": "https://www.taggun.io/api/receipt/v1/benchmark/download/be17cfba5acae69032b7856fd89f4286"
}'

Response Example

200 - Example 1

{
    "confidenceLevel": 0.7216666666666667,
    "date": {
        "confidenceLevel": 0.7216666666666667,
        "data": "2016-12-22T12:00:00.000Z"
    },
    "error": "string",
    "merchantAddress": {
        "confidenceLevel": 0.7216666666666667,
        "data": "2 Tapora St, Auckland, 1010, New Zealand"
    },
    "merchantCity": {
        "confidenceLevel": 0.7216666666666667,
        "data": "Auckland"
    },
    "merchantCountryCode": {
        "confidenceLevel": 0.7216666666666667,
        "data": "NZ"
    },
    "merchantName": {
        "confidenceLevel": 0.7216666666666667,
        "data": "Adina Apartment Hotel Auckland Britomart"
    },
    "merchantPostalCode": {
        "confidenceLevel": 0.7216666666666667,
        "data": "5001"
    },
    "merchantState": {
        "confidenceLevel": 0.7216666666666667,
        "data": "Auckland"
    },
    "merchantTypes": {
        "confidenceLevel": 0.7216666666666667,
        "data": [
            "restaurant",
            "food"
        ]
    },
    "taxAmount": {
        "confidenceLevel": 0.7216666666666667,
        "data": 3.04
    },
    "totalAmount": {
        "confidenceLevel": 0.7216666666666667,
        "data": 23.3
    }
}

Modified at 2022-09-11 13:29:45

transcribe a receipt using base64 encoded image in json payload

transcribe a receipt using base64 encoded image in json payload and return detailed result