Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Type

Description

entity

string

Key (primary identification) of an entity type, for example, iban. See available extraction entities Extraction Entities for possible values.

value

string

A normalized textual representation of the Text/Information provided by the extraction value, for example, iban without spaces between the digits.

box

bounding-box

Optional: bounding box containing the position of the extraction value on the document.

...

Name

Type

Description

candidates

string

Optional: A reference to extraction candidates. See available extraction candidates Extraction Entities for possible values.

...

Available specific extractions

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