FR Carte Nationale d'Identité

The Node.js 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

const mindee = require("mindee");
// for TS or modules:
// import * as mindee from "mindee";

// Init a new client
const mindeeClient = new mindee.Client({ apiKey: "my-api-key" });

// Load a file from disk
const inputSource = mindeeClient.docFromPath("/path/to/the/file.ext");

// Parse the file
const apiResponse = mindeeClient.parse(
  mindee.product.fr.IdCardV2,
  inputSource
);

// Handle the response Promise
apiResponse.then((resp) => {
  // print a string summary
  console.log(resp.document.toString());
});

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.

Basic Field

Each prediction object contains a set of fields that inherit from the generic Field class.

A typical Field object will have the following attributes:

• value (number | string): corresponds to the field value. Can be undefined if no value was extracted.

• confidence (number): 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 (number): the ID of the page, always undefined when at document-level.

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

A Point simply refers to an array of two numbers ([number, number]).

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

Classification Field

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

A classification field's value is always a string.

Date Field

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

• dateObject (Date): an accessible representation of the value as a JavaScript object.

String Field

The text field StringField only has one constraint: its value is a string (or undefined).

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 (StringField): The alternate name of the card holder.

console.log(result.document.inference.prediction.alternateName.value);

Issuing Authority

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

console.log(result.document.inference.prediction.authority.value);

Date of Birth

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

console.log(result.document.inference.prediction.birthDate.value);

Place of Birth

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

console.log(result.document.inference.prediction.birthPlace.value);

Card Access Number

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

console.log(result.document.inference.prediction.cardAccessNumber.value);

Document Number

documentNumber (StringField): The document number.

console.log(result.document.inference.prediction.documentNumber.value);

Document Sides

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

Possible values include:

• 'RECTO'

• 'VERSO'

• 'RECTO & VERSO'

for (const documentSideElem of result.document.documentSide) {
  console.log(documentSideElem.value);
}

Document Type

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

Possible values include:

• 'NEW'

• 'OLD'

for (const documentTypeElem of result.document.documentType) {
  console.log(documentTypeElem.value);
}

Expiry Date

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

console.log(result.document.inference.prediction.expiryDate.value);

Gender

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

console.log(result.document.inference.prediction.gender.value);

Given Name(s)

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

for (const givenNamesElem of result.document.inference.prediction.givenNames) {
  console.log(givenNamesElem.value);
}

Date of Issue

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

console.log(result.document.inference.prediction.issueDate.value);

Mrz Line 1

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

console.log(result.document.inference.prediction.mrz1.value);

Mrz Line 2

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

console.log(result.document.inference.prediction.mrz2.value);

Mrz Line 3

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

console.log(result.document.inference.prediction.mrz3.value);

Nationality

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

console.log(result.document.inference.prediction.nationality.value);

Surname

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

console.log(result.document.inference.prediction.surname.value);