Carte Nationale d’Identité 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.IdCardV2, input_doc)
# Print a summary of the API result
print(result.document)
# Print the document-level summary
# print(result.document.inference.prediction)
- class IdCardV2(raw_prediction)
Carte Nationale d’Identité 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] = 'idcard_fr'
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[IdCardV2Page]] Page-level prediction(s).
-
prediction:
IdCardV2Document Document-level prediction.
- product: Product
Name and version of a given product, as sent back by the API.
- class IdCardV2Document(raw_prediction, page_id=None)
Carte Nationale d’Identité API version 2.0 document data.
- Parameters:
raw_prediction (Dict[str, Any]) –
page_id (Optional[int]) –
-
alternate_name:
StringField The alternate name of the card holder.
-
authority:
StringField The name of the issuing authority.
-
birth_place:
StringField The place of birth of the card holder.
-
card_access_number:
StringField The card access number (CAN).
-
document_number:
StringField The document number.
-
gender:
StringField The gender of the card holder.
-
given_names:
List[StringField] The given name(s) of the card holder.
-
mrz1:
StringField The Machine Readable Zone, first line.
-
mrz2:
StringField The Machine Readable Zone, second line.
-
mrz3:
StringField The Machine Readable Zone, third line.
-
nationality:
StringField The nationality of the card holder.
-
surname:
StringField The surname of the card holder.
- class IdCardV2Page(raw_prediction, page_id=None)
Carte Nationale d’Identité API version 2.0 page data.
- Parameters:
raw_prediction (Dict[str, Any]) –
page_id (Optional[int]) –
- alternate_name: StringField
The alternate name of the card holder.
- authority: StringField
The name of the issuing authority.
- birth_date: DateField
The date of birth of the card holder.
- birth_place: StringField
The place of birth of the card holder.
- card_access_number: StringField
The card access number (CAN).
- document_number: StringField
The document number.
-
document_side:
ClassificationField The sides of the document which are visible.
-
document_type:
ClassificationField The document type or format.
- expiry_date: DateField
The expiry date of the identification card.
- gender: StringField
The gender of the card holder.
- given_names: List[StringField]
The given name(s) of the card holder.
- issue_date: DateField
The date of issue of the identification card.
- mrz1: StringField
The Machine Readable Zone, first line.
- mrz2: StringField
The Machine Readable Zone, second line.
- mrz3: StringField
The Machine Readable Zone, third line.
- nationality: StringField
The nationality of the card holder.
- surname: StringField
The surname of the card holder.