Sign in

v3

latestSwagger 2.02026-08-0125316174.5 KB
5. Campaign Validation

validate and match a receipt against campaign validation settings from URL

post/api/validation/v1/campaign/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.

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.

campaignIdstring required

The ID of the campaign to validate the receipt

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",
  "ipAddress": "32.4.2.223",
  "near": "Kalamazoo, MI, USA",
  "language": "en"
}

Response

Success