URL

Download a receipt from a public HTTPS URL and validate it against receipt validation rules supplied in the JSON request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uri
required
Defaults to https://example.com/receipts/receipt-123.png

Public HTTPS URL containing the receipt file. Private, localhost, and non-HTTPS URLs are rejected.

headers
object

Optional headers to forward while downloading the receipt URL.

validation
object
required

Receipt validation rules for this request. The generated example uses date and merchant name criteria; other receipt validation rule families are also accepted.

additionalExtractionFields
array of strings

Additional fields to expose on extracted objects. Currently supports modelNumber.

string
length ≤ 50

Namespace for receipt similarity checks when no campaign ID is used.

boolean
Defaults to false

Set true to avoid saving the receipt in storage.

string

IPv4 or IPv6 address of the end user.

string

Geographic hint for merchant search, typically city, state, country.

string
length ≤ 50

Receipt reference ID for feedback/training and receipt similarity checks.

string
length ≤ 50

End-user ID for duplicate receipt checks.

string
length ≤ 100

Optional sub-account identifier.

string
enum

Two-letter language hint. Leave empty for auto-detection.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json