Bank Account Details V2

Sample Code:

from mindee import Client, PredictResponse, product

# Init a new client
mindee_client = Client(api_key="my-api-key")

# Load a file from disk
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")

# Load a file from disk and parse it.
# The endpoint name must be specified since it cannot be determined from the class.
result: PredictResponse = mindee_client.parse(product.fr.BankAccountDetailsV2, input_doc)

# Print a summary of the API result
print(result.document)

# Print the document-level summary
# print(result.document.inference.prediction)

class BankAccountDetailsV2(raw_prediction)

Bank Account Details API version 2 inference prediction.

static get_endpoint_info(klass)

Retrives the endpoint information for an Inference.

Should never retrieve info for CustomV1, as a custom endpoint should be created to use CustomV1.

Parameters:

klass (Type[Inference]) – product subclass to access endpoint information.

Return type:

Dict[str, str]

endpoint_name: Optional[str] = 'bank_account_details'

Name of the endpoint.

endpoint_version: Optional[str] = '2'

Version of the endpoint.

is_rotation_applied: Optional[bool]

Whether the document has had any rotation applied to it.

page_id: Optional[int]

Optional page id for page-level predictions.

pages: List[Page[BankAccountDetailsV2Document]]

Page-level prediction(s).

prediction: BankAccountDetailsV2Document

Document-level prediction.

product: Product

Name and version of a given product, as sent back by the API.

class BankAccountDetailsV2Document(raw_prediction, page_id=None)

Bank Account Details API version 2.0 document data.

Parameters:

• raw_prediction (Dict[str, Any]) –

• page_id (Optional[int]) –

account_holders_names: StringField

Full extraction of the account holders names.

bban: BankAccountDetailsV2Bban

Full extraction of BBAN, including: branch code, bank code, account and key.

iban: StringField

Full extraction of the IBAN number.

swift_code: StringField

Full extraction of the SWIFT code.

class BankAccountDetailsV2Bban(raw_prediction, page_id=None)

Full extraction of BBAN, including: branch code, bank code, account and key.

Parameters:

• raw_prediction (Dict[str, Any]) –

• page_id (Optional[int]) –

to_field_list()

Output the object in a format suitable for inclusion in an rST field list.

Return type:

str

bban_bank_code: Optional[str]

The BBAN bank code outputted as a string.

bban_branch_code: Optional[str]

The BBAN branch code outputted as a string.

bban_key: Optional[str]

The BBAN key outputted as a string.

bban_number: Optional[str]

The BBAN Account number outputted as a string.

bounding_box: Optional[Quadrilateral]

A right rectangle containing the word in the document.

confidence: float

The confidence score.

page_n: int

The document page on which the information was found.

polygon: Polygon

A polygon containing the word in the document.