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

पहचान और दस्तावेज़

पहचान सत्यापन API: दस्तावेज़ OCR और प्रामाणिकता

Didit के साथ 220+ देशों और 14,000+ प्रकार के पहचान दस्तावेज़ सत्यापित करें। प्रामाणिकता, OCR, MRZ, 2 सेकंड से कम अनुमान, प्रति उपयोग मूल्य, कोई अनुबंध नहीं।

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

प्राधिकरण

x-api-key

string

header

आवश्यक

आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी, कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं। देखें https://docs.didit.me/console/api-keys।

बॉडी

multipart/form-data

front_image

file

आवश्यक

पहचान दस्तावेज़ का सामने का भाग। स्वीकृत एक्सटेंशन: tiff, jpg, jpeg, png, webp, pdf। अधिकतम अपलोड आकार: 10 MB (फ़ाइलें इससे बड़ी होने पर 400 के साथ अस्वीकृत कर दी जाती हैं)। OCR से पहले PDF को एक इमेज के रूप में रेंडर किया जाता है; एन्क्रिप्टेड PDF के लिए front_image_password आवश्यक है। इमेज स्वचालित रूप से ~0.5 MB तक कंप्रेस की जाती हैं और EXIF ओरिएंटेशन लागू किया जाता है। दस्तावेज़ के सभी चारों कोनों को दृश्यमान रखते हुए पूरा, अनक्रॉप किया गया कैप्चर अपलोड करें।

front_image_password

string

write-only

front_image को डिक्रिप्ट करने का पासवर्ड जब यह एक एन्क्रिप्टेड PDF हो। बिना (या गलत) पासवर्ड के एन्क्रिप्टेड PDF भेजने पर 400 मिलता है।

back_image

file

दस्तावेज़ का पिछला भाग — जब भी दस्तावेज़ में यह हो, इसे भेजें (कई पहचान पत्रों के पीछे MRZ या बारकोड होता है; इसे छोड़ने पर रिस्पॉन्स में MRZ और पिछले भाग के फ़ील्ड खाली रह जाते हैं — यह endpoint अनुपलब्ध-MRZ चेतावनी नहीं उठाता है)। front_image के समान प्रारूप और आकार सीमाएँ। छोड़ दिए जाने पर, रिस्पॉन्स में back_image और पिछले भाग के फ़ील्ड null होते हैं।

back_image_password

string

write-only

back_image को डिक्रिप्ट करने का पासवर्ड जब यह एक एन्क्रिप्टेड PDF हो।

perform_document_liveness

boolean

डिफ़ॉल्ट:true

प्रेज़ेंटेशन धोखाधड़ी के लिए दोनों छवियों को स्क्रीन करता है: स्क्रीन रीप्ले (SCREEN_CAPTURE_DETECTED), प्रिंट की गई प्रतियां (PRINTED_COPY_DETECTED), और पोर्ट्रेट हेरफेर (PORTRAIT_MANIPULATION_DETECTED)। इनमें से कोई भी मिलने पर इसे स्वतः अस्वीकृत कर दिया जाता है। डिफ़ॉल्ट रूप से सक्षम; धोखाधड़ी स्क्रीनिंग को छोड़ने और लेटेंसी कम करने के लिए false पर सेट करें। सक्षम होने पर और प्रदाता द्वारा कोई उपयोगी स्कोर न लौटाए जाने पर, रिस्पॉन्स Approved के बजाय DOCUMENT_LIVENESS_NOT_COMPUTED चेतावनी के साथ In Review होता है।

उदाहरण:

true

minimum_age

integer | null

स्वीकृत और मान्य (1–120) लेकिन इस endpoint द्वारा वर्तमान में लागू नहीं किया गया — यह इस फ़ील्ड से कभी भी MINIMUM_AGE_NOT_MET चेतावनी उत्पन्न नहीं करता है। लौटाए गए date_of_birth/age से आयु नियमों को लागू करें, या आयु प्रतिबंधों वाले सत्यापन सत्र वर्कफ़्लो का उपयोग करें।

आवश्यक सीमा: 1 <= x <= 120

expiration_date_not_detected_action

enum<string>

डिफ़ॉल्ट:NO_ACTION

जब कोई समाप्ति तिथि नहीं पढ़ी जा सकी (EXPIRATION_DATE_NOT_DETECTED) तो क्या कार्रवाई करें। डिफ़ॉल्ट NO_ACTION क्योंकि कई पहचान दस्तावेज़ों पर कोई समाप्ति तिथि मुद्रित नहीं होती है। ध्यान दें: एक पता लगाई गई और समाप्त हो चुकी समाप्ति तिथि इस विकल्प की परवाह किए बिना हमेशा अस्वीकार (DOCUMENT_EXPIRED) करती है।

उपलब्ध विकल्प:

NO_ACTION,

DECLINE

invalid_mrz_action

enum<string>

डिफ़ॉल्ट:DECLINE

निकाले गए MRZ के चेक-डिजिट सत्यापन में विफल होने (MRZ_VALIDATION_FAILED) पर क्या कार्रवाई की जाए। इस endpoint पर अनुपलब्ध MRZ कोई चेतावनी ट्रिगर नहीं करता है। केवल उन दस्तावेज़ों के लिए प्रासंगिक है जिनमें MRZ होता है। REVIEW इस endpoint पर समर्थित नहीं है और 400 लौटाता है।

उपलब्ध विकल्प:

NO_ACTION,

DECLINE

inconsistent_data_action

enum<string>

डिफ़ॉल्ट:DECLINE

जब निकाला गया डेटा आंतरिक रूप से असंगत हो तो क्या कार्रवाई करें: DATA_INCONSISTENT, MRZ_AND_DATA_EXTRACTED_FROM_OCR_NOT_SAME (दृश्य क्षेत्र MRZ से मेल नहीं खाता), या DOCUMENT_NAME_DIFFERENT_FROM_OTHER_APPROVED_DOCUMENTS।

उपलब्ध विकल्प:

NO_ACTION,

DECLINE

critical_field_occlusion_action

enum<string>

डिफ़ॉल्ट:DECLINE

जब कैप्चर पर कोई महत्वपूर्ण मुद्रित फ़ील्ड भौतिक रूप से ढका हुआ था (CRITICAL_FIELD_OCCLUSION_DETECTED) - एक पहचान संख्या, एक नाम, जन्म तिथि, या समाप्ति तिथि, तो क्या कार्रवाई करें। इस endpoint के अन्य दस्तावेज़-अखंडता जोखिमों की तरह, डिफ़ॉल्ट रूप से अस्वीकृत करता है: वे नंबर ढके होना जिनसे रिपोर्ट का मिलान किया जाता है, एक जानकारी छिपाए गए दस्तावेज़ जैसा दिखता है। ढके हुए फ़ील्ड के लिए पढ़े गए मान को दोनों ही स्थितियों में निष्कर्षण से हटा दिया जाता है, इसलिए संबंधित *_NOT_DETECTED चेतावनी आमतौर पर इसके साथ आती है। इस endpoint पर REVIEW समर्थित नहीं है और यह 400 लौटाता है।

उपलब्ध विकल्प:

NO_ACTION,

DECLINE

document_or_personal_number_format_mismatch_action

enum<string>

डिफ़ॉल्ट:NO_ACTION

जब कोई संख्या उस दस्तावेज़ प्रकार के लिए उसके जारीकर्ता प्राधिकरण द्वारा उपयोग किए जाने वाले प्रारूप से मेल नहीं खाती है (DOCUMENT_NUMBER_FORMAT_MISMATCH, PERSONAL_NUMBER_FORMAT_MISMATCH) तो क्या कार्रवाई करें। डिफ़ॉल्ट NO_ACTION, जो स्थिति को बदले बिना चेतावनी की रिपोर्ट करता है। इस endpoint पर REVIEW समर्थित नहीं है और यह 400 लौटाता है।

उपलब्ध विकल्प:

NO_ACTION,

DECLINE

preferred_characters

enum<string>

डिफ़ॉल्ट:latin

उन दस्तावेज़ों पर नाम/पते फ़ील्ड के लिए पसंदीदा लिपि जो लैटिन और गैर-लैटिन दोनों पाठ (अरबी, सिरिलिक, CJK, …) प्रिंट करते हैं। latin लिप्यंतरित/लैटिन मान लौटाता है; non_latin मूल लिपि को प्राथमिकता देता है।

उपलब्ध विकल्प:

latin,

non_latin

save_api_request

boolean

डिफ़ॉल्ट:true

true (डिफ़ॉल्ट) होने पर, कॉल को API-प्रकार के सत्र के रूप में बनाए रखता है — Business Console में दृश्यमान, लौटाए गए request_id का उपयोग करके GET /v3/session/{sessionId}/decision/ के माध्यम से प्राप्त करने योग्य, status.updated webhook के माध्यम से घोषित, और दस्तावेज़ छवियों को मीडिया URL के रूप में लौटाया जाता है। false होने पर, कुछ भी संग्रहीत नहीं किया जाता है, request_id एक अस्थायी UUID होता है, और छवियां इनलाइन base64 JPEG स्ट्रिंग्स के रूप में लौटाई जाती हैं।

उदाहरण:

true

vendor_data

string

वैकल्पिक अपारदर्शी स्ट्रिंग (आपकी आंतरिक उपयोगकर्ता ID, ईमेल, UUID…) जो स्थायी सत्र पर संग्रहीत होती है और रिस्पॉन्स में वापस भेजी जाती है। इसका उपयोग अपने स्वयं के रिकॉर्ड के साथ API कॉल को सहसंबंधित करने और बाद में सत्रों को फ़िल्टर करने के लिए करें।

उदाहरण:

"user-123"

metadata

object

सत्र के साथ संग्रहीत वैकल्पिक JSON ऑब्जेक्ट (जब save_api_request=true) और रिस्पॉन्स में वापस प्रतिध्वनित होता है। मल्टीपार्ट अनुरोधों में, इसे JSON-एन्कोडेड स्ट्रिंग फ़ील्ड (उदा. metadata={"flow":"onboarding"}) के रूप में भेजें — इसे एक ऑब्जेक्ट में पार्स किया जाता है।

उदाहरण:

{ "flow": "onboarding" }

प्रतिक्रिया

दस्तावेज़ संसाधित। id_verification.status Approved, Declined, या In Review है; हर संसूचित समस्या को id_verification.warnings में सूचीबद्ध किया गया है। In Review तब लौटाया जाता है जब अनुरोधित दस्तावेज़-लाइवनेस जांच से कोई उपयोगी परिणाम प्राप्त नहीं हुआ (DOCUMENT_LIVENESS_NOT_COMPUTED)। समस्याग्रस्त दस्तावेज़ भी status: "Declined" के साथ 200 लौटाता है — केवल HTTP कोड ही नहीं, बल्कि बॉडी का भी निरीक्षण करें। जब save_api_request=true हो, तो request_id स्थायी सत्र id होती है और छवि फ़ील्ड अल्पकालिक मीडिया URL होते हैं; save_api_request=false के साथ वे इनलाइन base64 JPEG स्ट्रिंग होते हैं।

request_id

string<uuid>

save_api_request=true होने पर सहेजी गई सत्र ID (GET /v3/session/{sessionId}/decision/ के साथ उपयोग योग्य); अन्यथा एक क्षणिक सहसंबंध UUID।

id_verification

object

Show child attributes

vendor_data

string | null

आपके द्वारा भेजे गए vendor_data का इको, या null।

metadata

object | null

आपके द्वारा भेजे गए metadata ऑब्जेक्ट का इको, या null।

created_at

string<date-time>

रिस्पॉन्स जनरेट होने का ISO 8601 टाइमस्टैम्प (UTC)।

अंतिम संशोधन 7 नवंबर 2026