FR Carte Vitale OCR Python

The Python OCR SDK supports the Carte Vitale API.

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


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(, input_doc)

# Print a summary of the API result

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

Output (RST):

:Mindee ID: 8c25cc63-212b-4537-9c9b-3fbd3bd0ee20
:Filename: default_sample.jpg

:Product: mindee/carte_vitale v1.0
:Rotation applied: Yes

:Given Name(s): NATHALIE
:Surname: DURAND
:Social Security Number: 269054958815780
:Issuance Date: 2007-01-01

Page Predictions

Page 0
:Given Name(s): NATHALIE
:Surname: DURAND
:Social Security Number: 269054958815780
:Issuance Date: 2007-01-01

Field Types

Standard Fields

These fields are generic and used in several products.


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, is None when at document-level.
  • reconstructed (bool): indicates whether an object was reconstructed (not extracted as the API gave it).

Note: 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.


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.


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


The following fields are extracted for Carte Vitale V1:

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:

Issuance Date

issuance_date (DateField): The date the card was issued.


Social Security Number

social_security (StringField): The Social Security Number (Numéro de Sécurité Sociale) of the card holder



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



Join our Slack