Setting Up Validation Campaigns

Define receipt rules once, then validate every submission against them: the campaign validation workflow, integration flow, and core concepts.

Purchase validation campaigns let you define receipt rules once, then validate each submitted receipt against those rules. A campaign can check receipt dates, merchants, product line items, product codes, balance owing, duplicate receipts, tampering signals, digital receipt signals, and narrowly scoped SmartValidate prompts.

📘
New to receipt validation? Start with Receipt Validation Fundamentals.

Availability

📘
Availability: Receipt validation is included on the Advanced plan and above. Enable Campaign Validation in your account Feature Settings when it is available on your plan. See Plans & Feature Access.
If the Campaign Validation control is not available on your account, contact [email protected].

Campaign Validation Workflow

Step	Page	Use it to
1	Campaign Settings Reference	Define the rules for a campaign ID.
2	Validating Receipts	Submit receipt files or receipt URLs against a campaign.
3	Managing Campaigns	List, retrieve, update, or delete campaign settings.

Integration Flow

Choose a stable campaignId.
Create campaign settings with POST /api/validation/v1/campaign/settings/create/{campaignId}.
Submit receipts to either:
- POST /api/validation/v1/campaign/receipt-validation/file
- POST /api/validation/v1/campaign/receipt-validation/url
Read the successful, failedValidations, and passedValidations fields in the validation response.
Use the management endpoints to retrieve, update, list, or delete campaign settings as your campaign changes.

Core Concepts

Concept	Meaning
`campaignId`	Your identifier for the validation campaign. It is used in the settings endpoint path and in each validation request.
Campaign settings	The rules that receipts are checked against. These include optional sections for date, merchant names, product codes, product line items, balance owing, fraud detection, and SmartValidate prompts.
`userId`	Optional end-user identifier associated with the submission and returned with matched receipts, when available, so cross-user reuse can be investigated. Maximum 50 characters.
Validation keys	Machine-readable strings in `passedValidations` and `failedValidations` that identify which checks passed or failed.

Related API References

Need something not covered here? Contact [email protected] — see Contacting Support.

Updated 9 days ago

Did this page help you?