FR Carte Nationale d'Identité

The Python SDK supports the Mindee V1 Carte Nationale d'Identité API.

Product Specifications

Specification	Details
Endpoint Name	idcard_fr
Recommended Version	v2.0
Supports Polling/Webhooks	❌ No
Support Synchronous HTTP Calls	✔️ Yes
Geography	🇫🇷 France

Quick-Start

Using the sample below, we are going to illustrate how to extract the data that we want using the SDK.

Sample Code

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

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.
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)

Sample Output (rST)

########
Document
########
:Mindee ID: d33828f1-ef7e-4984-b9df-a2bfaa38a78d
:Filename: default_sample.jpg

Inference
#########
:Product: mindee/idcard_fr v2.0
:Rotation applied: Yes

Prediction
==========
:Nationality:
:Card Access Number: 175775H55790
:Document Number:
:Given Name(s): Victor
                Marie
:Surname: DAMBARD
:Alternate Name:
:Date of Birth: 1994-04-24
:Place of Birth: LYON 4E ARRONDISSEM
:Gender: M
:Expiry Date: 2030-04-02
:Mrz Line 1: IDFRADAMBARD<<<<<<<<<<<<<<<<<<075025
:Mrz Line 2: 170775H557903VICTOR<<MARIE<9404246M5
:Mrz Line 3:
:Date of Issue: 2015-04-03
:Issuing Authority: SOUS-PREFECTURE DE BELLE (02)

Page Predictions
================

Page 0
------
:Document Type: OLD
:Document Sides: RECTO & VERSO
:Nationality:
:Card Access Number: 175775H55790
:Document Number:
:Given Name(s): Victor
                Marie
:Surname: DAMBARD
:Alternate Name:
:Date of Birth: 1994-04-24
:Place of Birth: LYON 4E ARRONDISSEM
:Gender: M
:Expiry Date: 2030-04-02
:Mrz Line 1: IDFRADAMBARD<<<<<<<<<<<<<<<<<<075025
:Mrz Line 2: 170775H557903VICTOR<<MARIE<9404246M5
:Mrz Line 3:
:Date of Issue: 2015-04-03
:Issuing Authority: SOUS-PREFECTURE DE BELLE (02)

Standard Fields

These fields are generic and used in several products.

BaseField

Each prediction object contains a set of fields that inherit from the generic BaseField class. A typical BaseField object will have the following attributes:

• value (Union[float, str]): corresponds to the field value. Can be None if no value was extracted.

• confidence (float): the confidence score of the field prediction.

• bounding_box ([Point, Point, Point, Point]): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.

• polygon (List[Point]): contains the relative vertices coordinates (Point) of a polygon containing the field in the image.

• page_id (int): the ID of the page, always None when at document-level.

• reconstructed (bool): indicates whether an object was reconstructed (not extracted as the API gave it).

A Point simply refers to a list of two numbers ([float, float]).

Aside from the previous attributes, all basic fields have access to a custom __str__ method that can be used to print their value as a string.

ClassificationField

The classification field ClassificationField does not implement all the basic BaseField attributes. It only implements value, confidence and page_id.

A classification field's `value is always a `str`. {% endhint %}

DateField

Aside from the basic BaseField attributes, the date field DateField also implements the following:

• date_object (Date): an accessible representation of the value as a python object. Can be None.

StringField

The text field StringField only has one constraint: its value is an Optional[str].

Page-Level Fields

Some fields are constrained to the page level, and so will not be retrievable at document level.

Attributes

The following fields are extracted for Carte Nationale d'Identité V2:

Alternate Name

alternate_name (StringField): The alternate name of the card holder.

print(result.document.inference.prediction.alternate_name.value)

Issuing Authority

authority (StringField): The name of the issuing authority.

print(result.document.inference.prediction.authority.value)

Date of Birth

birth_date (DateField): The date of birth of the card holder.

print(result.document.inference.prediction.birth_date.value)

Place of Birth

birth_place (StringField): The place of birth of the card holder.

print(result.document.inference.prediction.birth_place.value)

Card Access Number

card_access_number (StringField): The card access number (CAN).

print(result.document.inference.prediction.card_access_number.value)

Document Number

document_number (StringField): The document number.

print(result.document.inference.prediction.document_number.value)

Document Sides

📄document_side (ClassificationField): The sides of the document which are visible.

Possible values include:

• 'RECTO'

• 'VERSO'

• 'RECTO & VERSO'

for document_side_elem in result.document.document_side:
    print(document_side_elem.value)

Document Type

📄document_type (ClassificationField): The document type or format.

Possible values include:

• 'NEW'

• 'OLD'

for document_type_elem in result.document.document_type:
    print(document_type_elem.value)

Expiry Date

expiry_date (DateField): The expiry date of the identification card.

print(result.document.inference.prediction.expiry_date.value)

Gender

gender (StringField): The gender of the card holder.

print(result.document.inference.prediction.gender.value)

Given Name(s)

given_names (List[StringField]): The given name(s) of the card holder.

for given_names_elem in result.document.inference.prediction.given_names:
    print(given_names_elem.value)

Date of Issue

issue_date (DateField): The date of issue of the identification card.

print(result.document.inference.prediction.issue_date.value)

Mrz Line 1

mrz1 (StringField): The Machine Readable Zone, first line.

print(result.document.inference.prediction.mrz1.value)

Mrz Line 2

mrz2 (StringField): The Machine Readable Zone, second line.

print(result.document.inference.prediction.mrz2.value)

Mrz Line 3

mrz3 (StringField): The Machine Readable Zone, third line.

print(result.document.inference.prediction.mrz3.value)

Nationality

nationality (StringField): The nationality of the card holder.

print(result.document.inference.prediction.nationality.value)

Surname

surname (StringField): The surname of the card holder.

print(result.document.inference.prediction.surname.value)