Receipt Validation Overview

Validate receipts against rules supplied inline with each request.

What Receipt Validation Does

Receipt validation checks a submitted receipt against validation rules — dates, merchants, and other criteria — and returns a pass/fail result with the reasons. The endpoints in this category take those rules inline with each request: you send the receipt and a validation rule set together. This suits one-off checks, short promotions, and integrations that manage their own rules.

🚧

Beta

Receipt Validation is in beta: request and response details may change, and the feature must be enabled on your account. Contact [email protected] to discuss enabling it or to give feedback.

Endpoints in This Category

EndpointMethod and path
Upload FilePOST /api/validation/v1/receipt-validation/file
URLPOST /api/validation/v1/receipt-validation/url

Upload File sends the receipt as multipart/form-data with the rules as a JSON string; URL sends a JSON body pointing at a public HTTPS receipt URL with the rules as a JSON object.

Typical Workflow

  1. Build the validation rule set for this request — for example a date window and an allowed merchant list.
  2. Submit the receipt with the rules to Upload File or URL.
  3. Read the result — pass/fail with the reasons each rule matched or failed, so your application can tell the end user why.

Related Guides

Parameters

Every endpoint here authenticates with your API key. validation carries the rules; the input field depends on the endpoint.

ParameterTypeWhereDescription
apikeyheaderrequired, both endpointsYour API key. See Authentication.
validationstring / objectrequiredThe validation rule set for this request — a JSON string on Upload File (multipart fields carry text), a JSON object on URL.
filefilerequired on Upload FileSupported receipt or invoice file per Document Types & File Requirements.
urlstringrequired on URLHTTPS URL of the receipt, reachable by Taggun; private-network targets are rejected.
headersobjectoptional on URLHTTP headers to forward when fetching a protected HTTPS resource.
additionalExtractionFieldsarrayoptionalAdditional fields to expose on extracted objects. Currently supports ["modelNumber"].
containerIdstringoptional, ≤50Namespaces similarity checks across related submissions (e.g. one promotion or event) when no campaign is used.
languagestringoptionalLanguage hint; leave empty for automatic detection (same examples as extraction — not an allowlist).
nearstringoptionalA location (city, state, country) to help search for the merchant.
ipAddressstringoptional, ≤100End user's IP address, used for GeoIP lookup.
incognitobooleanoptional, default falsePer-request storage opt-out. See Security, Privacy & Data Residency.
userIdstringoptional, ≤50End-user identifier returned with matched receipts, when available.
subAccountIdstringoptional, ≤100Attribute usage to a client or subdivision of your account for reporting.
referenceIdstringoptional, ≤50Caller-supplied identifier. See Duplicate & Similarity Detection.