Skip to main content

Data Extraction

Docutains Data Extraction/ Data Capture SDK for iOS can extract document data based on the detected text.

Docutain's iOS SDK needs to be initialized prior to using any functionality of it as described here.


In order to get the detected data of the scanned or imported document, call the following line of code:

import DocutainSdk

...

//scan or import file

...

let jsonData = DocumentDataReader.analyze()

The detected data will be returned as JSON string. Depending on how you configured your AnalyzeConfiguration after initializing the SDK (see here), the structure will be one of the two following. The differences will be in IBAN, Bank and PaymentState.

When reading BIC is deactivated (default behaviour), you will get a value IBAN which contains all detected IBANs:

{
    "Address":
    {
        "Name1": "Verbandsgemeindeverwaltung Nastätten",
        "Name2": "",
        "Name3": "",
        "Zipcode": "56352",
        "City": "Nastätten",
        "Street": "Postfach",
        "Phone": "06772 802 0",
        "CustomerId": "",
        "IBAN": ["DE76570928000208303503", "DE41510500150710030316"]
    },
    "Date": "2020-01-24",
    "Amount": "940.84",
    "InvoiceId": "20/VA06894/0009500",
    "Reference": "RNr:20/VA06894/0009500 vom 24.01.2020"
}

When reading BIC is activated, you will get a value Bank which contains tuples of the BIC and the IBAN, if any detected:

{
    "Address":
    {
        "Name1": "Verbandsgemeindeverwaltung Nastätten",
        "Name2": "",
        "Name3": "",
        "Zipcode": "56352",
        "City": "Nastätten",
        "Street": "Postfach",
        "Phone": "06772 802 0",
        "CustomerId": "",
        "Bank": [{"BIC": "GENODE51DIE",
        "IBAN": "DE76570928000208303503"},
        {"BIC": "NASSDE55XXX",
        "IBAN": "DE41510500150710030316"}]
    },
    "Date": "2020-01-24",
    "Amount": "940.84",
    "InvoiceId": "20/VA06894/0009500",
    "Reference": "RNr:20/VA06894/0009500 vom 24.01.2020"
}

When reading the payment state is activated, you will get a value PaymentState which contains either Paid or ToBePaid:

{
    "Address":
    {
        "Name1": "Verbandsgemeindeverwaltung Nastätten",
        "Name2": "",
        "Name3": "",
        "Zipcode": "56352",
        "City": "Nastätten",
        "Street": "Postfach",
        "Phone": "06772 802 0",
        "CustomerId": "",
        "Bank": [{"BIC": "GENODE51DIE",
        "IBAN": "DE76570928000208303503"},
        {"BIC": "NASSDE55XXX",
        "IBAN": "DE41510500150710030316"}]
    },
    "Date": "2020-01-24",
    "Amount": "940.84",
    "InvoiceId": "20/VA06894/0009500",
    "Reference": "RNr:20/VA06894/0009500 vom 24.01.2020",
    "PaymentState": "ToBePaid"
}