An extraction contains an entity that describes a general semantic type of the extraction, such as iban, bic, or amount. The entity also determines the format of the value containing text information. There might be an optional box element describing the position of the extraction value on the document. We refer to it as the bounding box. In most cases, the extractions without a bounding box are considered to be meta information such as doctype.
Name | Type | Description |
|---|---|---|
|
| Key (primary identification) of an entity type, for example, |
|
| A normalized textual representation of the Text/Information provided by the extraction value, for example, iban without spaces between the digits. |
| 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 |
|---|---|---|
|
| Optional: A reference to extraction candidates. See available extraction candidates for possible values. |
Available specific extractions
Name | Description | Entity | Candidates |
|---|---|---|---|
amountToPay | The amount which yet to be paid. | amounts | |
bic | The bic of a payment recipient. | bics | |
docType | The document type of a given document. | n/a | |
iban | The IBAN of a document sender. | ibans | |
paymentPurpose | The payment purpose text | n/a | |
paymentRecipient | The payment recipient, beneficiary of a money transfer activity | paymentRecipients | |
paymentReference | The payment reference. | n/a |