v3

latestSwagger 2.02026-08-0125316174.5 KB

4. Receipt Validation

validate a receipt against receipt validation rules from URL

post/api/validation/v1/receipt-validation/url

Headers

apikeystring required

API authentication key.

Request body

urlstring required

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

additionalExtractionFieldsModel68[]

Additional fields to expose on extracted objects

containerIdstring

Tag a request with a container ID for fraud detection purposes

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.

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

subAccountIdstring

Tag a request with a subAccountId

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

Example request

{
  "url": "https://files.readme.io/57ca9b1717a5dbdd7f56a913f47d2f758ffedaa08375dc5ac31d6fe76c4d3d32-example-taggun-receipt.png",
  "validation": {
    "date": {
      "start": "2026-06-01T00:00:00.000Z",
      "end": "2026-06-30T23:59:59.999Z"
    },
    "merchantName": {
      "allowed": [
        "H-E-B"
      ],
      "blocked": [
        "Blocked Merchant"
      ]
    },
    "productCodes": {
      "description": "Find product codes for Test Product",
      "allowed": [
        "MAF-01010101"
      ]
    },
    "balanceOwing": {
      "max": 100
    },
    "productLineItems": {
      "products": [
        {
          "names": [
            "Apple",
            "Banana"
          ],
          "sku": {
            "allowed": [
              "SKU-123",
              "SKU-456"
            ]
          },
          "modelNumber": {
            "allowed": [
              "MODEL-123",
              "MODEL-456"
            ]
          }
        }
      ]
    },
    "fraudDetection": {
      "similarityCheck": {
        "enabled": true
      },
      "tamperDetection": {
        "enabled": true
      },
      "digitalDetection": {
        "enabled": true,
        "required": false
      }
    },
    "smartValidate": {
      "prompts": [
        {
          "key": "is_credit_card_payment",
          "question": "Is this a credit card payment?"
        }
      ]
    }
  },
  "additionalExtractionFields": [
    "modelNumber"
  ],
  "ipAddress": "32.4.2.223",
  "near": "Kalamazoo, MI, USA",
  "language": "en"
}

Response

Success