FR Carte Nationale d'Identité OCR PHP
The PHP OCR SDK supports the Carte Nationale d'Identité API.
Using the sample below, we are going to illustrate how to extract the data that we want using the OCR SDK.
Quick-Start
<?php
use Mindee\Client;
use Mindee\Product\Fr\IdCard\IdCardV2;
// 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(IdCardV2::class, $inputSource);
echo $apiResponse->document;
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)
Field Types
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 (
float|string
): corresponds to the field value. Can benull
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, alwaysnull
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.
ClassificationField
The classification field ClassificationField
does not implement all the basic BaseField
attributes. It only implements value, confidence and pageId.
Note: a classification field's
value is always a
string`.
DateField
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 benull
.
StringField
The text field StringField
implements the following:
- value (
string
): represents the value of the field as a string. - rawValue (
string
): the value of the string as it appears on the document.
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
alternateName : The alternate name of the card holder.
echo $result->document->inference->prediction->alternateName->value;
Issuing Authority
authority : The name of the issuing authority.
echo $result->document->inference->prediction->authority->value;
Date of Birth
birthDate : The date of birth of the card holder.
echo $result->document->inference->prediction->birthDate->value;
Place of Birth
birthPlace : The place of birth of the card holder.
echo $result->document->inference->prediction->birthPlace->value;
Card Access Number
cardAccessNumber : The card access number (CAN).
echo $result->document->inference->prediction->cardAccessNumber->value;
Document Number
documentNumber : The document number.
echo $result->document->inference->prediction->documentNumber->value;
Document Sides
📄documentSide : The sides of the document which are visible.
Possible values include:
- RECTO
- VERSO
- RECTO & VERSO
foreach($result->document->inference->prediction->documentSide as $documentSideElem)
{
echo $documentSideElem->value;
}
Document Type
📄documentType : The document type or format.
Possible values include:
- NEW
- OLD
foreach($result->document->inference->prediction->documentType as $documentTypeElem)
{
echo $documentTypeElem->value;
}
Expiry Date
expiryDate : The expiry date of the identification card.
echo $result->document->inference->prediction->expiryDate->value;
Gender
gender : The gender of the card holder.
echo $result->document->inference->prediction->gender->value;
Given Name(s)
givenNames : The given name(s) of the card holder.
foreach ($result->document->inference->prediction->givenNames as $givenNamesElem)
{
echo $givenNamesElem->value;
}
Date of Issue
issueDate : The date of issue of the identification card.
echo $result->document->inference->prediction->issueDate->value;
Mrz Line 1
mrz1 : The Machine Readable Zone, first line.
echo $result->document->inference->prediction->mrz1->value;
Mrz Line 2
mrz2 : The Machine Readable Zone, second line.
echo $result->document->inference->prediction->mrz2->value;
Mrz Line 3
mrz3 : The Machine Readable Zone, third line.
echo $result->document->inference->prediction->mrz3->value;
Nationality
nationality : The nationality of the card holder.
echo $result->document->inference->prediction->nationality->value;
Surname
surname : The surname of the card holder.
echo $result->document->inference->prediction->surname->value;
Questions?
Updated about 2 months ago