Page Comparison

...

Name	Type	Description
`entity`	`string`	Key (primary identification) of an entity type (e.g. `iban`). See available extraction entities for possible values.
`value`	`string`	A normalized textual representation of the Text/Information provided by the extraction value (e.g. iban without spaces between the digits).
`box`	bounding-box	(Optional) bounding box containing the position of the extraction value on the document.

...

Specific extractions

A specific extraction assigns a semantic property to the extraction. It also has an additional candidates field:

Name	Type	Description
`candidates`	`string`	(Optional) A reference to extraction candidates. See available extraction candidates for possible values.

...

Name	Description	Entity	Candidates
amountToPay	The amount which yet to be paid.	amount	amounts
bic	The bic of a payment recipient.	bic	bics
docType	The document type of a given document.	doctype	n/a
iban	The IBAN of a document sender.	iban	ibans
paymentPurpose	The payment purpose text	text	n/a
paymentRecipient	The payment recipient, beneficiary of a money transfer activity	companyname	paymentRecipients
paymentReference	The payment reference.	reference	n/a
amountsAreConsistent	(Return Assistant) A special extraction to check the correctness of the line item values.	amounts_are_consistent	n/a
shipment-addon	(Return Assistant) The amount of a shipment cost.	amount	n/a
discount-addon	(Return Assistant) The amount of a discount.	amount	n/a
giftcard-addon	(Return Assistant) The amount of a discount issued in a form of a giftcard.	amount	n/a
other-discounts-addon	(Return Assistant) The total sum of all additional discounts.	amount	n/a
other-charges-addon	(Return Assistant) The total sum of all additional charges.	amount	n/a