transcribe a receipt from URL and return detailed result
POST
/api/receipt/v1/verbose/url
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.taggun.io//api/receipt/v1/verbose/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 Response Example
200 - Example 1
{
"amounts": [
"string"
],
"confidenceLevel": 0.7216666666666667,
"date": {
"confidenceLevel": 0.7216666666666667,
"data": "2016-12-22T12:00:00.000Z",
"index": 2,
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "22DEC'16"
},
"elapsed": "24200",
"entities": {
"ABN": {
"confidenceLevel": 0.7216666666666667,
"data": "string",
"keyword": "string",
"text": "string"
},
"IBAN": {
"confidenceLevel": 0.7216666666666667,
"data": "123456",
"keyword": "IBAN",
"text": "123456"
},
"belgiumVATNumbers": [
{
"confidenceLevel": 0.7216666666666667,
"data": "0660914448",
"keyword": "",
"text": "BE0660.914.448"
}
],
"excludeItems": [
{
"confidenceLevel": 0.7216666666666667,
"data": 3,
"keyword": "coke",
"text": "零系可樂"
}
],
"fapiaoInvoice": {
"confidenceLevel": 0.7216666666666667,
"data": true,
"keyword": "发票",
"text": "发票"
},
"fapiaoInvoiceCode": {
"confidenceLevel": 0.7216666666666667,
"data": "033001800104",
"keyword": "",
"text": "033001800104"
},
"fapiaoInvoiceNumber": {
"confidenceLevel": 0.7216666666666667,
"data": "80227830",
"keyword": "",
"text": "80227830"
},
"fapiaoMerchantTaxId": {
"confidenceLevel": 0.7216666666666667,
"data": "913101156073309979",
"keyword": "",
"text": "913101156073309979"
},
"geoNames": [
{
"confidenceLevel": 0.7216666666666667,
"data": 3,
"keyword": "France",
"text": "France"
}
],
"invoiceNumber": {
"confidenceLevel": 0.7216666666666667,
"data": "123456",
"keyword": "Invoice number",
"text": "123456"
},
"lineItems": [
{
"confidenceLevel": 0.7216666666666667,
"data": {
"metadata_type": {
"data": "brand_infini",
"text": "Infini"
},
"quantity": {
"data": 2,
"text": "qty 2 @ ..."
},
"unitPrice": {
"data": 26.99,
"text": " $48.00"
}
},
"index": 3,
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "1 Infini E/Day S/Less T/Tee XL $48.00"
}
],
"merchantVerification": {
"confidenceLevel": 0.7216666666666667,
"data": {
"countryCode": "IE",
"vatNo": "950###8N",
"verificationId": "IE950###8N",
"vies": {
"address": "1 Someplace street, Ireland",
"countryCode": "IE",
"error": "IE",
"name": "Merchant Name",
"valid": true,
"vatNumber": "950###8N"
}
},
"index": 3,
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "VAT no: IE 95###8N"
},
"multiTaxLineItems": [
{
"confidenceLevel": 0.7216666666666667,
"data": {
"grossAmount": {
"data": 15.83,
"text": "15,83"
},
"netAmount": {
"data": 15.01,
"text": "15,01"
},
"taxAmount": {
"data": 0.83,
"text": "0,83"
},
"taxRate": {
"data": 0.055,
"text": "5,50%"
},
"taxType": {
"data": "TVA",
"text": "TVA"
}
},
"index": 20,
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "TVA 5,50 15,01 0,83 15,83"
}
],
"qrCodeData": {
"confidenceLevel": 0.7216666666666667,
"data": "01,10,031001900211,15004826,109.72,20190617,11467310187259010073,908E",
"keyword": "",
"text": "01,10,031001900211,15004826,109.72,20190617,11467310187259010073,908E"
},
"receiptNumber": {
"confidenceLevel": 0.7216666666666667,
"data": "11/220371",
"index": 3,
"keyword": "ReceiptNumber",
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "ReceiptNumber: 11/220371"
},
"shoppingMallName": {
"confidenceLevel": 0.7216666666666667,
"data": "Bass Hill Plaza",
"index": 3,
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "Some Shop Name - Bass Hill"
},
"wineListItems": [
{
"productName": {
"confidenceLevel": 0.7216666666666667,
"keyword": "CDIGI_19_crimes",
"text": "19 crimes"
},
"quantity": {
"data": 2,
"text": "qty 2 @ ..."
},
"unitPrice": {
"data": 26.99,
"text": "cab Sauvignon $26.99"
},
"wineVarietal": {
"confidenceLevel": 0.7216666666666667,
"keyword": "cabernet_sauvignon",
"text": "cab Sauvignon"
}
}
]
},
"error": "string",
"itemsCount": {
"confidenceLevel": 0.7216666666666667,
"data": 11
},
"lineAmounts": [
"string"
],
"location": {
"city": {
"geoname_id": 2207724,
"names": {
"en": "Devonport"
}
},
"continent": {
"code": "OC",
"geoname_id": 6255151,
"names": {
"de": "Ozeanien",
"en": "Oceania",
"es": "Oceanía",
"fr": "Océanie",
"ja": "オセアニア",
"pt-BR": "Oceania",
"ru": "Океания",
"zh-CN": "大洋洲"
}
},
"country": {
"geoname_id": 2186224,
"iso_code": "NZ",
"names": {
"de": "Neuseeland",
"en": "New Zealand",
"es": "Nueva Zelanda",
"fr": "Nouvelle-Zélande",
"ja": "ニュージーランド",
"pt-BR": "Nova Zelândia",
"ru": "Новая Зеландия",
"zh-CN": "新西兰"
}
},
"location": {
"accuracy_radius": 500,
"latitude": -36.8297,
"longitude": 174.7994,
"time_zone": "Pacific/Auckland"
},
"postal": {
"code": "0624"
},
"registered_country": {
"geoname_id": 2186224,
"iso_code": "NZ",
"names": {
"de": "Neuseeland",
"en": "New Zealand",
"es": "Nueva Zelanda",
"fr": "Nouvelle-Zélande",
"ja": "ニュージーランド",
"pt-BR": "Nova Zelândia",
"ru": "Новая Зеландия",
"zh-CN": "新西兰"
}
},
"subdivisions": [
{
"geoname_id": 2193734,
"iso_code": "AUK",
"names": {
"de": "Auckland",
"en": "Auckland",
"es": "Auckland",
"fr": "Auckland",
"ja": "オークランド",
"pt-BR": "Auckland",
"ru": "Окленд"
}
}
]
},
"merchantAddress": {
"confidenceLevel": 0.7216666666666667,
"data": "2 Tapora St, Auckland, 1010, New Zealand",
"index": 2,
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "22DEC'16"
},
"merchantCity": {
"confidenceLevel": 0.7216666666666667,
"data": "Auckland",
"index": 2,
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "string"
},
"merchantCountryCode": {
"confidenceLevel": 0.7216666666666667,
"data": "NZ",
"index": 2,
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "Auckland"
},
"merchantName": {
"confidenceLevel": 0.7216666666666667,
"data": "Adina Apartment Hotel Auckland Britomart",
"index": 2,
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "22DEC'16"
},
"merchantPostalCode": {
"confidenceLevel": 0.7216666666666667,
"data": "1010",
"index": 2,
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "Auckland, 1010"
},
"merchantState": {
"confidenceLevel": 0.7216666666666667,
"data": "Auckland",
"index": 2,
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "Auckland"
},
"merchantTypes": {
"confidenceLevel": 0.7216666666666667,
"data": [
"restaurant",
"food"
],
"index": 2,
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "22DEC'16"
},
"numbers": [
"string"
],
"paymentType": {
"confidenceLevel": 0.7216666666666667,
"data": "mastercard",
"index": 2,
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "22DEC'16"
},
"taxAmount": {
"confidenceLevel": 0.7216666666666667,
"currencyCode": "NZD",
"data": 3.04,
"index": 7,
"keyword": "GST",
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "3.04"
},
"text": {
"regions": [
"string"
],
"text": "Lorem ipsum\nbeer isyum"
},
"totalAmount": {
"confidenceLevel": 0.7216666666666667,
"currencyCode": "NZD",
"data": 23.3,
"index": 11,
"keyword": "TOTAL",
"regions": [
[
{
"x": 437,
"y": 787
},
{
"x": 499,
"y": 788
},
{
"x": 499,
"y": 808
},
{
"x": 437,
"y": 807
}
]
],
"text": "23.30"
}
}Request
Header Params
Body Params application/json
Responses
Modified at 2022-09-11 13:29:45