Passport 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.PassportV1,
    input_doc,
)

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

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

class PassportV1(raw_prediction)

Passport 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 = 'passport'

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[PassportV1Document]]

Page-level prediction(s).

prediction: PassportV1Document

Document-level prediction.

product: Product

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

class PassportV1Document(raw_prediction, page_id=None)

Passport API version 1.1 document data.

Parameters:

• raw_prediction (dict[str, Any])

• page_id (int | None)

birth_date: DateField

The date of birth of the passport holder.

birth_place: StringField

The place of birth of the passport holder.

country: StringField

The country’s 3 letter code (ISO 3166-1 alpha-3).

expiry_date: DateField

The expiry date of the passport.

gender: StringField

The gender of the passport holder.

given_names: list[StringField]

The given name(s) of the passport holder.

id_number: StringField

The passport’s identification number.

issuance_date: DateField

The date the passport was issued.

mrz1: StringField

Machine Readable Zone, first line

mrz2: StringField

Machine Readable Zone, second line

surname: StringField

The surname of the passport holder.