Bank Check V1

Sample Code:

#
# Install the Python client library by running:
# pip install mindee
#

from mindee.v1 import Client, PredictResponse, product
from mindee import PathInput

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

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

# Load a file from disk and parse it.
result: PredictResponse = mindee_client.parse(
    product.us.BankCheckV1,
    input_doc,
)

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

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

class BankCheckV1(raw_prediction)

Bank Check API version 1 inference prediction.

Parameters:: raw_prediction (dict[str, Any])

static get_endpoint_info(klass)

Retrieves 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: str | None = 'bank_check': Name of the endpoint.

endpoint_version: str | None = '1': Version of the endpoint.

extras: Extras | None = None: Potential Extras fields sent back along with the prediction.

is_rotation_applied: bool | None: Whether the document has had any rotation applied to it.

page_id: int | None: Optional page id for page-level predictions.

pages: list[Page[BankCheckV1Page]]: Page-level prediction(s).

prediction: BankCheckV1Document: Document-level prediction.

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

class BankCheckV1Document(raw_prediction, page_id=None)

Bank Check API version 1.1 document data.

Parameters:

raw_prediction (dict[str, Any])
page_id (int | None)

account_number: StringField: The check payer’s account number.

amount: AmountField: The amount of the check.

check_number: StringField: The issuer’s check number.

date: DateField: The date the check was issued.

payees: list[StringField]: List of the check’s payees (recipients).

routing_number: StringField: The check issuer’s routing number.

class BankCheckV1Page(raw_prediction, page_id=None)

Bank Check API version 1.1 page data.

Parameters:

raw_prediction (dict[str, Any])
page_id (int | None)

account_number: StringField: The check payer’s account number.

amount: AmountField: The amount of the check.

check_number: StringField: The issuer’s check number.

check_position: PositionField: The position of the check on the document.

date: DateField: The date the check was issued.

payees: list[StringField]: List of the check’s payees (recipients).

routing_number: StringField: The check issuer’s routing number.

signatures_positions: list[PositionField]: List of signature positions