Métadonnées en sortie

Champs

L'objet document contient des informations sur le document présenté lors de l'identification. Cet objet est inclus dans la réponse lorsque le statut d'identification est traité.

 

Attribute

Type

Description

FirstName

string

Prénom extrait du document (Zone visuelle)

LastName

string

Nom extrait du document (Zone visuelle)

Birthdate

string (format: YYYY-MM-DD)

Date de naissance extraite du document (Zone visuelle)

ExpirationDate

string (format: YYYY-MM-DD)

Date d'expiration extraite du document (Zone visuelle)

Gender

string

Genre de l'utilisateur, M, F ou NULL.

IssueDate

string (format: YYYY-MM-DD)

Date de délivrance extraite du document (Zone visuelle)

MRZ

string

Zone MRZ extraite du document.

ID

string

Numéro de document extrait du document.

Classes

Attribute

Type

Description

DocumentType

string

Catégorie du document, l'un des suivants (ID, PASSPORT, POR, PERMIS)

DocumentFace

string

Face du document, l'un des suivants (RECTO, VERSO)

Exemples

{
"entities": [
{
"id": "043d528b-a313-401a-8f12-7bcf1f03d001",
"confidence": 0.9999908208847046,
"name": "Firstname",
"text": "Gérard",
"value": "Gérard",
"bounding_box": [],
"page": 1,
"document_number": 1,
"document_id": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto",
"step": "step-1",
"action": "document",
"document_name": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto.jpg",
},
{
"id": "043d528b-a313-401a-8f12-7bcf1f03d001",
"confidence": 0.9999908208847046,
"name": "Face",
"bounding_box": [],
"page": 1,
"document_number": 1,
"document_id": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto",
"step": "step-1",
"action": "face",
"document_name": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto.jpg",
}
],
"validations": [
{
"message": "Luminosité détectée",
"code": "Luminosity",
"id": "5fe11296-cfd5-4b02-8e88-ae86b5e878e9",
"type": "node",
"document_name": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto.jpg",
"document_id": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto",
"step": "step-1",
"action": "luminosity",
"page": 1,
"nodes": [],
"tags": [],
"name": "Luminosity",
"weight": 1,
"validate": true,
"type_validation": "Luminosity",
"document_number": 1
},
],
"class": [
{
"id": "d6ed11c9-4f68-4a9d-9246-d3cc64282ced",
"name": "POR",
"confidence": 0.9755672216415405,
"color": "#808080",
"page": 1,
"document_number": 1,
"document_id": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto",
"step": "step-1",
"action": "document_type",
"document_name": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto.jpg"
},
{
"id": "cbfd7e8a-0340-41a8-a20c-0a0ac72db5c3",
"name": "RECTO",
"confidence": 1,
"color": "#808080",
"page": 1,
"document_number": 1,
"document_id": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto",
"step": "step-1",
"action": "document_face",
"document_name": "Py5CCdjNYgUH3hBTExciC5Gb-por-recto.jpg"
}
],
"form": {
"document_type": "por",
"document_country": "FR"
}
}