API de verificación de documentos: OCR y autenticidad

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"
}

Autorizaciones

x-api-key

string

header

requerido

La clave de API de tu aplicación, que encontrarás en Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener un alcance limitado: ninguno, lectura o escritura por recurso, limitada a algunos flujos o a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, se revocó o expiró; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud provino de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, videos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys.

Cuerpo

multipart/form-data

front_image

file

requerido

Anverso del documento de identidad. Extensiones permitidas: tiff, jpg, jpeg, png, webp, pdf. Tamaño máximo de carga: 10 MB (los archivos más grandes se rechazan con 400). Los PDF se convierten en imagen antes del OCR; los PDF cifrados requieren front_image_password. Las imágenes se comprimen automáticamente a ~0.5 MB y se aplica la orientación EXIF. Sube la captura completa, sin recortar, con las cuatro esquinas del documento visibles.

front_image_password

string

write-only

Contraseña para descifrar front_image cuando es un PDF cifrado. Enviar un PDF cifrado sin contraseña (o con una incorrecta) devuelve 400.

back_image

file

Reverso del documento: envíalo siempre que el documento lo tenga (muchos documentos de identidad llevan la MRZ o un código de barras en el reverso; si lo omites, la MRZ y los campos del reverso simplemente quedan vacíos en la respuesta, y este endpoint no genera una advertencia por falta de MRZ). Mismo formato y límites de tamaño que front_image. Si se omite, back_image y los campos del reverso son null en la respuesta.

back_image_password

string

write-only

Contraseña para descifrar back_image cuando es un PDF cifrado.

perform_document_liveness

boolean

predeterminado:true

Analiza ambas imágenes en busca de fraude de presentación: reproducciones en pantalla (SCREEN_CAPTURE_DETECTED), copias impresas (PRINTED_COPY_DETECTED) y manipulación del retrato (PORTRAIT_MANIPULATION_DETECTED). Cualquiera de ellos provoca un rechazo automático. Está activado por defecto. Establécelo en false para omitir el análisis de fraude y reducir la latencia. Si está activado y el proveedor no devuelve una puntuación utilizable, la respuesta es In Review con una advertencia DOCUMENT_LIVENESS_NOT_COMPUTED en lugar de Approved.

Ejemplo:

true

minimum_age

integer | null

Se acepta y se valida (1–120), pero actualmente este endpoint no lo aplica: nunca genera una advertencia MINIMUM_AGE_NOT_MET a partir de este campo. Aplica las reglas de edad a partir de los valores date_of_birth/age devueltos, o usa un flujo de sesión de verificación con restricciones de edad.

Rango requerido: 1 <= x <= 120

expiration_date_not_detected_action

enum<string>

predeterminado:NO_ACTION

Qué hacer cuando no se puede leer ninguna fecha de caducidad (EXPIRATION_DATE_NOT_DETECTED). El valor predeterminado es NO_ACTION porque muchos documentos de identidad no llevan impresa la fecha de caducidad. Nota: una fecha de caducidad detectada y ya vencida siempre provoca el rechazo (DOCUMENT_EXPIRED), independientemente de esta opción.

Opciones disponibles:

NO_ACTION,

DECLINE

invalid_mrz_action

enum<string>

predeterminado:DECLINE

Qué hacer cuando la MRZ extraída no supera la validación de los dígitos de control (MRZ_VALIDATION_FAILED). Si falta la MRZ, este endpoint no genera ninguna advertencia. Solo aplica a documentos que incluyen MRZ. REVIEW no se admite en este endpoint y devuelve 400.

Opciones disponibles:

NO_ACTION,

DECLINE

inconsistent_data_action

enum<string>

predeterminado:DECLINE

Qué hacer cuando los datos extraídos son incoherentes entre sí: DATA_INCONSISTENT, MRZ_AND_DATA_EXTRACTED_FROM_OCR_NOT_SAME (la zona visual no coincide con la MRZ) o DOCUMENT_NAME_DIFFERENT_FROM_OTHER_APPROVED_DOCUMENTS.

Opciones disponibles:

NO_ACTION,

DECLINE

critical_field_occlusion_action

enum<string>

predeterminado:DECLINE

Qué hacer cuando un campo impreso crítico estaba tapado físicamente en la captura (CRITICAL_FIELD_OCCLUSION_DETECTED): un número de identidad, un nombre, la fecha de nacimiento o la fecha de caducidad. Rechaza por defecto, como los demás riesgos de integridad del documento de este endpoint: tapar los números con los que se concilia un informe es justo el aspecto de un documento censurado. En cualquier caso, el valor leído de un campo tapado se elimina de la extracción, por lo que suele ir acompañado de la advertencia *_NOT_DETECTED correspondiente. REVIEW no es compatible con este endpoint y devuelve 400.

Opciones disponibles:

NO_ACTION,

DECLINE

document_or_personal_number_format_mismatch_action

enum<string>

predeterminado:NO_ACTION

Qué hacer cuando un número no coincide con el formato que usa su autoridad emisora para ese tipo de documento (DOCUMENT_NUMBER_FORMAT_MISMATCH, PERSONAL_NUMBER_FORMAT_MISMATCH). El valor predeterminado es NO_ACTION, que informa de la advertencia sin cambiar el estado. REVIEW no es compatible con este endpoint y devuelve 400.

Opciones disponibles:

NO_ACTION,

DECLINE

preferred_characters

enum<string>

predeterminado:latin

Alfabeto preferido para los campos de nombre y dirección en documentos que imprimen texto tanto latino como no latino (árabe, cirílico, CJK, …). latin devuelve valores transliterados o latinos; non_latin da preferencia al alfabeto nativo.

Opciones disponibles:

latin,

non_latin

save_api_request

boolean

predeterminado:true

Cuando es true (valor predeterminado), guarda la llamada como una sesión de tipo API: visible en la Business Console, recuperable mediante GET /v3/session/{sessionId}/decision/ con el request_id devuelto, notificada mediante un webhook status.updated y con las imágenes del documento devueltas como URL de archivos multimedia. Cuando es false, no se almacena nada, request_id es un UUID temporal y las imágenes se devuelven en la propia respuesta como cadenas JPEG en base64.

Ejemplo:

true

vendor_data

string

Cadena opaca opcional (tu ID de usuario interno, correo electrónico, UUID…) que se guarda en la sesión persistida y se devuelve en la respuesta. Úsala para relacionar las llamadas a la API con tus propios registros y para filtrar sesiones más adelante.

Ejemplo:

"user-123"

metadata

object

Objeto JSON opcional que se almacena con la sesión (cuando save_api_request=true) y se devuelve en la respuesta. En solicitudes multipart, envíalo como un campo de cadena codificado en JSON (p. ej., metadata={"flow":"onboarding"}): se convierte en un objeto.

Ejemplo:

{ "flow": "onboarding" }

Respuesta

Documento procesado. id_verification.status es Approved, Declined o In Review; cada problema detectado se detalla en id_verification.warnings. Se devuelve In Review cuando una comprobación de prueba de vida del documento solicitada no produjo un resultado utilizable (DOCUMENT_LIVENESS_NOT_COMPUTED). Un documento con problemas también devuelve 200 con status: "Declined": revisa el cuerpo, no solo el código HTTP. Cuando save_api_request=true, request_id es el ID de la sesión guardada y los campos de imagen son URL de medios de corta duración; con save_api_request=false son cadenas JPEG en base64 incluidas en la respuesta.

request_id

string<uuid>

ID de la sesión guardada cuando save_api_request=true (se puede usar con GET /v3/session/{sessionId}/decision/); en caso contrario, un UUID de correlación temporal.

id_verification

object

Show child attributes

vendor_data

string | null

Devuelve el vendor_data que enviaste, o null.

metadata

object | null

Devuelve el objeto metadata que enviaste, o null.

created_at

string<date-time>

Marca de tiempo ISO 8601 (UTC) del momento en que se generó la respuesta.

Última modificación el 1 de noviembre de 2026