Simple Extraction Overview

What Simple Extraction Returns

Simple endpoints return the compact core-field schema: total amount, tax amount, date, and merchant details, each with its confidence level. The payload is small, stable, and quick to parse — built for production integrations that need the essentials and nothing more.

Simple or Verbose?

Choose simple when the core fields answer your use case: expense capture, receipt totals reconciliation, or any flow where you store a handful of values per document. Every input method below also has a verbose form that returns the broader extraction schema — line items, per-field metadata, and feature envelopes — from the same request shape, so you can switch depth later without changing how you submit documents.

👍
Evaluating Taggun?
Use the verbose form while you evaluate — it shows everything the platform can extract. Move to simple once you know the core fields are all you need.

Endpoints in This Category

Endpoint	Method and path	Example response
Upload File (simple)	`POST /api/receipt/v1/simple/file`	Example JSON
URL (simple)	`POST /api/receipt/v1/simple/url`	Example JSON
Encoded File (simple)	`POST /api/receipt/v1/simple/encoded`	Example JSON

The input methods mirror the verbose category: multipart file upload, a public HTTPS URL, or base64-encoded content in a JSON body. Accepted document types and size limits are defined once in Document Types & File Requirements.

Related Guides

Quick Start — first scan in a few minutes.
Understanding Your Results — read responses field by field.
Document Types & File Requirements — accepted formats and limits.
Performance & Response Times — typical timings and integration patterns.

Parameters

Every endpoint in this category authenticates with your API key and shares the optional parameters below alongside its input fields.

Parameter	Type	Where	Description
`apikey`	header	required, all endpoints	Your API key. See Authentication.
`file`	file	required on Upload File	Supported receipt or invoice file per Document Types & File Requirements.
`url`	string	required on URL	HTTPS URL of the receipt, reachable by Taggun. HTTP, localhost, loopback, link-local, and private-network targets are rejected.
`headers`	object	optional on URL	HTTP headers to forward when fetching a protected HTTPS resource.
`image`, `filename`, `contentType`	string	required on Encoded File	Base64 content (`image` is a legacy field name — PDFs accepted), file name, and MIME type.
`extractTime`	boolean	optional, default `false`	Set to `true` to return the time when found on the receipt; otherwise time is `12:00:00.000`.
`language`	string	optional	Language hint; leave empty for automatic detection. Common hints include `en`, `es`, `fr`, `jp`, `he`, `iw`, `et`, `lv`, `lt`, `fi`, `el`, `zh`, `th`, `ar`, `kh` — examples, not an allowlist.
`near`	string	optional	A location (city, state, country) to help search for the merchant.
`ipAddress`	string	optional, ≤100	End user's IP address, used for GeoIP lookup.
`ignoreMerchantName`	string	optional	A merchant name to ignore if detected on the file (e.g. a customer name mistaken for the merchant).
`refresh`	boolean	optional, default `false`	Set to `true` to force reprocessing if the receipt is already stored.
`incognito`	boolean	optional, default `false`	Per-request storage opt-out. See Security, Privacy & Data Residency.
`userId`	string	optional, ≤50	End-user identifier returned with matched receipts, when available, so cross-user reuse can be investigated.
`containerId`	string	optional, ≤50	Scopes duplicate & similarity checks to scans sharing the same value. Omit to compare account-wide.
`subAccountId`	string	optional, ≤50	Attribute usage to a client or subdivision of your account for reporting. Does not create a separate account.
`referenceId`	string	optional, ≤50	Caller-supplied identifier. See Duplicate & Similarity Detection.