API de vérification d'identité : OCR et authenticité

cURL

curl -X POST 'https://verification.didit.me/v3/id-verification/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -F 'front_image=@./id_front.jpg' \
  -F 'back_image=@./id_back.jpg' \
  -F 'perform_document_liveness=true' \
  -F 'save_api_request=true' \
  -F 'vendor_data=user-123'

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.id_verification.verify(
    front_image=open("front_image.jpg", "rb"),
    back_image=open("back_image.jpg", "rb"),
    perform_document_liveness=True,
    save_api_request=True,
    vendor_data="user-123",
    metadata={"flow": "onboarding"},
)
print(result)

import Didit, { fileFromPath } from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.idVerification.verify({
  front_image: await fileFromPath("front_image.jpg"),
  back_image: await fileFromPath("back_image.jpg"),
  perform_document_liveness: true,
  save_api_request: true,
  vendor_data: "user-123",
  metadata: { flow: "onboarding" },
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.IDVerification.Verify(ctx, didit.IDVerificationVerifyParams{
	FrontImage:              didit.FileFromPath("front_image.jpg"),
	BackImage:               didit.Some(didit.FileFromPath("back_image.jpg")),
	PerformDocumentLiveness: didit.Bool(true),
	SaveAPIRequest:          didit.Bool(true),
	VendorData:              didit.String("user-123"),
	Metadata:                didit.Some(map[string]any{"flow": "onboarding"}),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import java.nio.file.Path;
import java.util.Map;
import me.didit.Didit;
import me.didit.types.IdVerificationVerifyParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.idVerification().verify(IdVerificationVerifyParams.builder()
        .frontImage(Path.of("front_image.jpg"))
        .backImage(Path.of("back_image.jpg"))
        .performDocumentLiveness(true)
        .saveApiRequest(true)
        .vendorData("user-123")
        .metadata(Map.of("flow", "onboarding"))
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;
use Didit\File;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->idVerification->verify([
    'front_image' => File::fromPath('front_image.jpg'),
    'back_image' => File::fromPath('back_image.jpg'),
    'perform_document_liveness' => true,
    'save_api_request' => true,
    'vendor_data' => 'user-123',
    'metadata' => ['flow' => 'onboarding'],
]);
print_r($result->toArray());

require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.id_verification.verify(
  front_image: Pathname("front_image.jpg"),
  back_image: Pathname("back_image.jpg"),
  perform_document_liveness: true,
  save_api_request: true,
  vendor_data: "user-123",
  metadata: { flow: "onboarding" }
)
puts result.to_h

using System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.IdVerification.VerifyAsync(new IdVerificationVerifyParams
{
    FrontImage = FileUpload.FromPath("front_image.jpg"),
    BackImage = FileUpload.FromPath("back_image.jpg"),
    PerformDocumentLiveness = true,
    SaveApiRequest = true,
    VendorData = "user-123",
    Metadata = new Dictionary<string, object> { ["flow"] = "onboarding" },
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "request_id": "11d219ed-d59c-4b1d-8d65-9b933f12d5b8",
  "id_verification": {
    "status": "Approved",
    "document_type": "Identity Card",
    "document_subtype": "ID_CARD_GENERIC",
    "document_number": "CBX164224",
    "personal_number": "20446581H",
    "portrait_image": "https://<media-host>/ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-portrait_image-8c2f.jpg?signature=...",
    "front_image": "https://<media-host>/ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-front_image-4a1e.jpg?signature=...",
    "back_image": "https://<media-host>/ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-back_image-77b0.jpg?signature=...",
    "front_image_camera_front": null,
    "back_image_camera_front": null,
    "front_image_camera_front_face_match_score": null,
    "back_image_camera_front_face_match_score": null,
    "front_image_quality_score": {
      "focus_score": 78,
      "brightness_score": 83.2,
      "brightness_issue": "ok",
      "is_document_fully_visible": true,
      "resolution_score": 40.7,
      "overall_score": 70.2
    },
    "back_image_quality_score": {
      "focus_score": 100,
      "brightness_score": 95.6,
      "brightness_issue": "ok",
      "is_document_fully_visible": true,
      "resolution_score": 43,
      "overall_score": 84.4
    },
    "date_of_birth": "1980-01-13",
    "age": 46,
    "expiration_date": "2032-03-31",
    "date_of_issue": "2022-03-31",
    "issuing_state": "ESP",
    "issuing_state_name": "Spain",
    "first_name": "Julio Francisco",
    "last_name": "Fores Sena",
    "full_name": "Julio Francisco Fores Sena",
    "gender": "M",
    "address": "Brda. Urb. El Cardonal 0052 52 Po3 B,Taco,San Cristobal De La Laguna,Santa Cruz De Tenerife",
    "formatted_address": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain",
    "place_of_birth": "Valencia, Valencia",
    "marital_status": "UNKNOWN",
    "nationality": "ESP",
    "extra_fields": {
      "first_surname": "Fores",
      "second_surname": "Sena"
    },
    "mrz": {
      "surname": "FORES SENA",
      "name": "JULIO FRANCISCO",
      "country": "ESP",
      "nationality": "ESP",
      "birth_date": "800113",
      "expiry_date": "320331",
      "sex": "M",
      "document_type": "ID",
      "document_number": "CBX164224",
      "optional_data": "20446581H",
      "optional_data_2": "",
      "birth_date_hash": "9",
      "expiry_date_hash": "8",
      "document_number_hash": "3",
      "final_hash": "3",
      "personal_number": "20446581H",
      "warnings": [],
      "errors": [],
      "mrz_type": "TD1",
      "mrz_string": "IDESPCBX164224320446581H<<<<<<\n8001139M3203318ESP<<<<<<<<<<<3\nFORES<SENA<<JULIO<FRANCISCO<<<",
      "mrz_key": "CBX164224380011393203318"
    },
    "parsed_address": {
      "street_1": "Avenida el Cardonal 52",
      "street_2": "b",
      "city": "La Laguna",
      "region": "Canarias",
      "country": "ES",
      "postal_code": "38108",
      "address_type": "Avenida",
      "formatted_address": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain",
      "raw_results": {
        "address_components": [
          {
            "long_name": "b",
            "short_name": "b",
            "types": [
              "subpremise"
            ]
          },
          {
            "long_name": "52",
            "short_name": "52",
            "types": [
              "street_number"
            ]
          },
          {
            "long_name": "Avenida el Cardonal",
            "short_name": "Av. el Cardonal",
            "types": [
              "route"
            ]
          },
          {
            "long_name": "La Laguna",
            "short_name": "La Laguna",
            "types": [
              "locality",
              "political"
            ]
          },
          {
            "long_name": "Spain",
            "short_name": "ES",
            "types": [
              "country",
              "political"
            ]
          },
          {
            "long_name": "38108",
            "short_name": "38108",
            "types": [
              "postal_code"
            ]
          }
        ],
        "formatted_address": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain",
        "geometry": {
          "location": {
            "lat": 28.4501161,
            "lng": -16.3004407
          },
          "location_type": "ROOFTOP"
        },
        "types": [
          "street_address",
          "subpremise"
        ]
      },
      "document_location": {
        "latitude": 28.4501161,
        "longitude": -16.3004407
      },
      "label": "Spain Identity Card Address",
      "is_verified": true,
      "category": "Residential"
    },
    "warnings": [],
    "barcodes": []
  },
  "vendor_data": "user-123",
  "metadata": {
    "flow": "onboarding"
  },
  "created_at": "2026-06-12T02:21:56.013573+00:00"
}

POST

id-verification

cURL

curl -X POST 'https://verification.didit.me/v3/id-verification/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -F 'front_image=@./id_front.jpg' \
  -F 'back_image=@./id_back.jpg' \
  -F 'perform_document_liveness=true' \
  -F 'save_api_request=true' \
  -F 'vendor_data=user-123'

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.id_verification.verify(
    front_image=open("front_image.jpg", "rb"),
    back_image=open("back_image.jpg", "rb"),
    perform_document_liveness=True,
    save_api_request=True,
    vendor_data="user-123",
    metadata={"flow": "onboarding"},
)
print(result)

import Didit, { fileFromPath } from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.idVerification.verify({
  front_image: await fileFromPath("front_image.jpg"),
  back_image: await fileFromPath("back_image.jpg"),
  perform_document_liveness: true,
  save_api_request: true,
  vendor_data: "user-123",
  metadata: { flow: "onboarding" },
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.IDVerification.Verify(ctx, didit.IDVerificationVerifyParams{
	FrontImage:              didit.FileFromPath("front_image.jpg"),
	BackImage:               didit.Some(didit.FileFromPath("back_image.jpg")),
	PerformDocumentLiveness: didit.Bool(true),
	SaveAPIRequest:          didit.Bool(true),
	VendorData:              didit.String("user-123"),
	Metadata:                didit.Some(map[string]any{"flow": "onboarding"}),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import java.nio.file.Path;
import java.util.Map;
import me.didit.Didit;
import me.didit.types.IdVerificationVerifyParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.idVerification().verify(IdVerificationVerifyParams.builder()
        .frontImage(Path.of("front_image.jpg"))
        .backImage(Path.of("back_image.jpg"))
        .performDocumentLiveness(true)
        .saveApiRequest(true)
        .vendorData("user-123")
        .metadata(Map.of("flow", "onboarding"))
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;
use Didit\File;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->idVerification->verify([
    'front_image' => File::fromPath('front_image.jpg'),
    'back_image' => File::fromPath('back_image.jpg'),
    'perform_document_liveness' => true,
    'save_api_request' => true,
    'vendor_data' => 'user-123',
    'metadata' => ['flow' => 'onboarding'],
]);
print_r($result->toArray());

require "didit"

# Reads DIDIT_API_KEY.
didit = Didit::Client.new

result = didit.id_verification.verify(
  front_image: Pathname("front_image.jpg"),
  back_image: Pathname("back_image.jpg"),
  perform_document_liveness: true,
  save_api_request: true,
  vendor_data: "user-123",
  metadata: { flow: "onboarding" }
)
puts result.to_h

using System;
using System.Collections.Generic;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.IdVerification.VerifyAsync(new IdVerificationVerifyParams
{
    FrontImage = FileUpload.FromPath("front_image.jpg"),
    BackImage = FileUpload.FromPath("back_image.jpg"),
    PerformDocumentLiveness = true,
    SaveApiRequest = true,
    VendorData = "user-123",
    Metadata = new Dictionary<string, object> { ["flow"] = "onboarding" },
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "request_id": "11d219ed-d59c-4b1d-8d65-9b933f12d5b8",
  "id_verification": {
    "status": "Approved",
    "document_type": "Identity Card",
    "document_subtype": "ID_CARD_GENERIC",
    "document_number": "CBX164224",
    "personal_number": "20446581H",
    "portrait_image": "https://<media-host>/ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-portrait_image-8c2f.jpg?signature=...",
    "front_image": "https://<media-host>/ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-front_image-4a1e.jpg?signature=...",
    "back_image": "https://<media-host>/ocr/11d219ed-d59c-4b1d-8d65-9b933f12d5b8-back_image-77b0.jpg?signature=...",
    "front_image_camera_front": null,
    "back_image_camera_front": null,
    "front_image_camera_front_face_match_score": null,
    "back_image_camera_front_face_match_score": null,
    "front_image_quality_score": {
      "focus_score": 78,
      "brightness_score": 83.2,
      "brightness_issue": "ok",
      "is_document_fully_visible": true,
      "resolution_score": 40.7,
      "overall_score": 70.2
    },
    "back_image_quality_score": {
      "focus_score": 100,
      "brightness_score": 95.6,
      "brightness_issue": "ok",
      "is_document_fully_visible": true,
      "resolution_score": 43,
      "overall_score": 84.4
    },
    "date_of_birth": "1980-01-13",
    "age": 46,
    "expiration_date": "2032-03-31",
    "date_of_issue": "2022-03-31",
    "issuing_state": "ESP",
    "issuing_state_name": "Spain",
    "first_name": "Julio Francisco",
    "last_name": "Fores Sena",
    "full_name": "Julio Francisco Fores Sena",
    "gender": "M",
    "address": "Brda. Urb. El Cardonal 0052 52 Po3 B,Taco,San Cristobal De La Laguna,Santa Cruz De Tenerife",
    "formatted_address": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain",
    "place_of_birth": "Valencia, Valencia",
    "marital_status": "UNKNOWN",
    "nationality": "ESP",
    "extra_fields": {
      "first_surname": "Fores",
      "second_surname": "Sena"
    },
    "mrz": {
      "surname": "FORES SENA",
      "name": "JULIO FRANCISCO",
      "country": "ESP",
      "nationality": "ESP",
      "birth_date": "800113",
      "expiry_date": "320331",
      "sex": "M",
      "document_type": "ID",
      "document_number": "CBX164224",
      "optional_data": "20446581H",
      "optional_data_2": "",
      "birth_date_hash": "9",
      "expiry_date_hash": "8",
      "document_number_hash": "3",
      "final_hash": "3",
      "personal_number": "20446581H",
      "warnings": [],
      "errors": [],
      "mrz_type": "TD1",
      "mrz_string": "IDESPCBX164224320446581H<<<<<<\n8001139M3203318ESP<<<<<<<<<<<3\nFORES<SENA<<JULIO<FRANCISCO<<<",
      "mrz_key": "CBX164224380011393203318"
    },
    "parsed_address": {
      "street_1": "Avenida el Cardonal 52",
      "street_2": "b",
      "city": "La Laguna",
      "region": "Canarias",
      "country": "ES",
      "postal_code": "38108",
      "address_type": "Avenida",
      "formatted_address": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain",
      "raw_results": {
        "address_components": [
          {
            "long_name": "b",
            "short_name": "b",
            "types": [
              "subpremise"
            ]
          },
          {
            "long_name": "52",
            "short_name": "52",
            "types": [
              "street_number"
            ]
          },
          {
            "long_name": "Avenida el Cardonal",
            "short_name": "Av. el Cardonal",
            "types": [
              "route"
            ]
          },
          {
            "long_name": "La Laguna",
            "short_name": "La Laguna",
            "types": [
              "locality",
              "political"
            ]
          },
          {
            "long_name": "Spain",
            "short_name": "ES",
            "types": [
              "country",
              "political"
            ]
          },
          {
            "long_name": "38108",
            "short_name": "38108",
            "types": [
              "postal_code"
            ]
          }
        ],
        "formatted_address": "Av. el Cardonal, 52, b, 38108 La Laguna, Santa Cruz de Tenerife, Spain",
        "geometry": {
          "location": {
            "lat": 28.4501161,
            "lng": -16.3004407
          },
          "location_type": "ROOFTOP"
        },
        "types": [
          "street_address",
          "subpremise"
        ]
      },
      "document_location": {
        "latitude": 28.4501161,
        "longitude": -16.3004407
      },
      "label": "Spain Identity Card Address",
      "is_verified": true,
      "category": "Residential"
    },
    "warnings": [],
    "barcodes": []
  },
  "vendor_data": "user-123",
  "metadata": {
    "flow": "onboarding"
  },
  "created_at": "2026-06-12T02:21:56.013573+00:00"
}

Autorisations

x-api-key

string

header

requis

La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.

Corps

multipart/form-data

front_image

file

requis

Recto du document d'identité. Extensions autorisées : tiff, jpg, jpeg, png, webp, pdf. Taille maximale de téléversement : 10 MB (les fichiers plus volumineux sont rejetés avec une erreur 400). Les PDF sont convertis en image avant l'OCR ; les PDF chiffrés nécessitent front_image_password. Les images sont automatiquement compressées à ~0.5 MB et l'orientation EXIF est appliquée. Téléversez la capture complète, non recadrée, avec les quatre coins du document visibles.

front_image_password

string

write-only

Mot de passe pour déchiffrer front_image lorsqu'il s'agit d'un PDF chiffré. L'envoi d'un PDF chiffré sans mot de passe (ou avec un mot de passe incorrect) renvoie 400.

back_image

file

Verso du document — envoyez-le chaque fois que le document en comporte un (de nombreuses cartes d'identité portent la MRZ ou un code-barres au verso ; l'omettre laisse simplement les champs de la MRZ et du verso vides dans la réponse — cet endpoint ne déclenche pas d'avertissement pour MRZ manquante). Mêmes formats et limites de taille que pour front_image. S'il est omis, back_image et les champs du verso sont null dans la réponse.

back_image_password

string

write-only

Mot de passe pour déchiffrer back_image lorsqu'il s'agit d'un PDF chiffré.

perform_document_liveness

boolean

défaut:true

Analyse les deux images à la recherche de fraude par présentation : rediffusions d'écran (SCREEN_CAPTURE_DETECTED), copies imprimées (PRINTED_COPY_DETECTED) et manipulation de portrait (PORTRAIT_MANIPULATION_DETECTED). L'un quelconque de ces éléments entraîne un refus automatique. Activé par défaut ; définissez sur false pour ignorer le filtrage de fraude et réduire la latence. Lorsqu'il est activé et que le fournisseur ne renvoie aucun score exploitable, la réponse est In Review avec un avertissement DOCUMENT_LIVENESS_NOT_COMPUTED plutôt que Approved.

Exemple:

true

minimum_age

integer | null

Accepté et validé (1–120) mais actuellement non appliqué par cet endpoint — il ne génère jamais d'avertissement MINIMUM_AGE_NOT_MET à partir de ce champ. Appliquez les règles d'âge à partir de date_of_birth/age renvoyés, ou utilisez un workflow de session de vérification avec des restrictions d'âge.

Plage requise: 1 <= x <= 120

expiration_date_not_detected_action

enum<string>

défaut:NO_ACTION

Ce qu'il faut faire lorsqu'aucune date d'expiration ne peut être lue (EXPIRATION_DATE_NOT_DETECTED). Par défaut NO_ACTION, car de nombreux documents d'identité n'affichent pas de date d'expiration. Remarque : une date d'expiration détectée et dépassée entraîne toujours un refus (DOCUMENT_EXPIRED), quelle que soit cette option.

Options disponibles:

NO_ACTION,

DECLINE

invalid_mrz_action

enum<string>

défaut:DECLINE

Que faire lorsque la MRZ extraite échoue à la validation de la clé de contrôle (MRZ_VALIDATION_FAILED). Une MRZ manquante ne génère aucun avertissement sur cet endpoint. Pertinent uniquement pour les documents comportant une MRZ. REVIEW n'est pas pris en charge sur cet endpoint et renvoie 400.

Options disponibles:

NO_ACTION,

DECLINE

inconsistent_data_action

enum<string>

défaut:DECLINE

Ce qu'il faut faire lorsque les données extraites sont incohérentes en interne : DATA_INCONSISTENT, MRZ_AND_DATA_EXTRACTED_FROM_OCR_NOT_SAME (la zone visuelle ne concorde pas avec la MRZ), ou DOCUMENT_NAME_DIFFERENT_FROM_OTHER_APPROVED_DOCUMENTS.

Options disponibles:

NO_ACTION,

DECLINE

critical_field_occlusion_action

enum<string>

défaut:DECLINE

Ce qu'il faut faire lorsqu'un champ imprimé critique a été physiquement masqué sur la capture (CRITICAL_FIELD_OCCLUSION_DETECTED) - un numéro d'identité, un nom, la date de naissance ou la date d'expiration. Entraîne un refus par défaut, comme les autres risques d'intégrité documentaire de cet endpoint : masquer les numéros sur lesquels un rapport est réconcilié correspond à ce à quoi ressemble un document caviardé. La valeur lue pour un champ masqué est supprimée de l'extraction dans tous les cas, de sorte que l'avertissement *_NOT_DETECTED correspondant l'accompagne généralement. REVIEW n'est pas pris en charge sur cet endpoint et renvoie 400.

Options disponibles:

NO_ACTION,

DECLINE

document_or_personal_number_format_mismatch_action

enum<string>

défaut:NO_ACTION

Ce qu'il faut faire lorsqu'un numéro ne correspond pas au format utilisé par son autorité émettrice pour ce type de document (DOCUMENT_NUMBER_FORMAT_MISMATCH, PERSONAL_NUMBER_FORMAT_MISMATCH). Par défaut NO_ACTION, ce qui signale l'avertissement sans modifier le statut. REVIEW n'est pas pris en charge sur cet endpoint et renvoie 400.

Options disponibles:

NO_ACTION,

DECLINE

preferred_characters

enum<string>

défaut:latin

Système d'écriture préféré pour les champs de nom/adresse sur les documents comportant à la fois du texte latin et non latin (arabe, cyrillique, CJK, …). latin renvoie des valeurs translittérées/latines ; non_latin privilégie le système d'écriture natif.

Options disponibles:

latin,

non_latin

save_api_request

boolean

défaut:true

Lorsque la valeur est true (par défaut), conserve l'appel sous la forme d'une session de type API — visible dans la Business Console, récupérable via GET /v3/session/{sessionId}/decision/ à l'aide du request_id renvoyé, notifiée via un webhook status.updated, et avec les images du document renvoyées sous forme d'URL de médias. Lorsque la valeur est false, rien n'est stocké, request_id est un UUID éphémère et les images sont renvoyées en ligne sous forme de chaînes JPEG en base64.

Exemple:

true

vendor_data

string

Chaîne opaque optionnelle (votre identifiant d'utilisateur interne, e-mail, UUID…) stockée sur la session persistée et renvoyée dans la réponse. Utilisez-la pour corréler les appels d'API avec vos propres enregistrements et pour filtrer les sessions ultérieurement.

Exemple:

"user-123"

metadata

object

Objet JSON optionnel stocké avec la session (lorsque save_api_request=true) et renvoyé dans la réponse. Dans les requêtes multipart, envoyez-le sous forme de champ textuel encodé en JSON (par ex. metadata={"flow":"onboarding"}) — il est analysé sous forme d'objet.

Exemple:

{ "flow": "onboarding" }

Réponse

Document traité. id_verification.status est Approved, Declined ou In Review ; chaque problème détecté est détaillé dans id_verification.warnings. In Review est renvoyé lorsqu'une vérification demandée de détection du vivant du document n'a produit aucun résultat exploitable (DOCUMENT_LIVENESS_NOT_COMPUTED). Un document problématique renvoie tout de même 200 avec status: "Declined" — inspectez le corps de la réponse, pas seulement le code HTTP. Lorsque save_api_request=true, request_id est l'identifiant de la session enregistrée et les champs d'image sont des URL de médias de courte durée ; avec save_api_request=false, ce sont des chaînes JPEG en base64 intégrées.

request_id

string<uuid>

Identifiant de session persistante lorsque save_api_request=true (utilisable avec GET /v3/session/{sessionId}/decision/) ; sinon un UUID de corrélation temporaire.

id_verification

object

Show child attributes

vendor_data

string | null

Écho des vendor_data que vous avez envoyées, ou null.

metadata

object | null

Écho de l'objet metadata que vous avez envoyé, ou null.

created_at

string<date-time>

Horodatage ISO 8601 (UTC) du moment où la réponse a été générée.

Dernière modification le 7 novembre 2026