FR Carte Vitale OCR PHP

The PHP 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



use Mindee\Client;
use Mindee\Product\Fr\CarteVitale\CarteVitaleV1;

// Init a new client
$mindeeClient = new Client("my-api-key");

// Load a file from disk
$inputSource = $mindeeClient->sourceFromPath("/path/to/the/file.ext");

// Parse the file
$apiResponse = $mindeeClient->parse(CarteVitaleV1::class, $inputSource);

echo strval($apiResponse->document);

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 (float|string): corresponds to the field value. Can be null if no value was extracted.
  • confidence (float): the confidence score of the field prediction.
  • boundingBox ([Point, Point, Point, Point]): contains exactly 4 relative vertices (points) coordinates of a right rectangle containing the field in the document.
  • polygon (Point[]): contains the relative vertices coordinates (Point) of a polygon containing the field in the image.
  • pageId (integer): the ID of the page, is null 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 __toString 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:

  • dateObject (date): an accessible representation of the value as a php object. Can be null.


The text field StringField only has one constraint: its value is an optional ?string.


The following fields are extracted for Carte Vitale V1:

Given Name(s)

givenNames : The given name(s) of the card holder.

foreach ($result->document->inference->prediction->givenNames as $givenNamesElem)
    echo $givenNamesElem->value;

Issuance Date

issuanceDate : The date the card was issued.

echo $result->document->inference->prediction->issuanceDate->value;

Social Security Number

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

echo $result->document->inference->prediction->socialSecurity->value;


surname : The surname of the card holder.

echo $result->document->inference->prediction->surname->value;


Join our Slack