curl

curl -X POST \
  https://verification.didit.me/v3/session/import-shared/ \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "share_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "trust_review": false,
    "workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
    "vendor_data": "user-1"
  }'

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.sessions.import_shared(
    share_token="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    trust_review=False,
    workflow_id="9f9b1234-aaaa-bbbb-cccc-1234567890ab",
    vendor_data="user-1",
)
print(result)

import Didit from "@didit-protocol/sdk-node";

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

const result = await didit.sessions.importShared({
  share_token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  trust_review: false,
  workflow_id: "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
  vendor_data: "user-1",
});
console.log(result);

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

result, err := client.Sessions.ImportShared(ctx, didit.SessionsImportSharedParams{
	ShareToken:  "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
	TrustReview: false,
	WorkflowID:  "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
	VendorData:  didit.String("user-1"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.SessionsImportSharedParams;

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

var result = client.sessions().importShared(SessionsImportSharedParams.builder()
        .shareToken("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...")
        .trustReview(false)
        .workflowId("9f9b1234-aaaa-bbbb-cccc-1234567890ab")
        .vendorData("user-1")
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

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

$result = $didit->sessions->importShared([
    'share_token' => 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',
    'trust_review' => false,
    'workflow_id' => '9f9b1234-aaaa-bbbb-cccc-1234567890ab',
    'vendor_data' => 'user-1',
]);
print_r($result->toArray());

require "didit"

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

result = didit.sessions.import_shared(
  share_token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  trust_review: false,
  workflow_id: "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
  vendor_data: "user-1"
)
puts result.to_h

using System;
using System.Text.Json;
using Didit;

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

var result = await client.Sessions.ImportSharedAsync(new SessionsImportSharedParams
{
    ShareToken = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    TrustReview = false,
    WorkflowId = "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
    VendorData = "user-1",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "session_id": "11111111-2222-3333-4444-555555555555",
  "session_kind": "user",
  "shared_from_session": "99999999-8888-7777-6666-555555555555",
  "session_number": 43762,
  "session_url": null,
  "status": "In Review",
  "workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
  "vendor_data": "user-1",
  "created_at": "2026-05-17T08:42:11Z",
  "expires_at": "2026-05-24T08:42:11Z"
}

उपयोगकर्ता और व्यवसाय सत्यापन

शेयर्ड सेशन इंपोर्ट API: पुनः प्रयोज्य KYC और KYB

Didit के POST /v3/session/import-shared/ से पार्टनर शेयर token द्वारा KYC या KYB सत्र इंपोर्ट करें। पुनः सत्यापन नहीं, प्रति कॉल भुगतान।

POST

session

import-shared

curl

curl -X POST \
  https://verification.didit.me/v3/session/import-shared/ \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "share_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "trust_review": false,
    "workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
    "vendor_data": "user-1"
  }'

from didit import Didit

# Reads DIDIT_API_KEY.
client = Didit()

result = client.sessions.import_shared(
    share_token="eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    trust_review=False,
    workflow_id="9f9b1234-aaaa-bbbb-cccc-1234567890ab",
    vendor_data="user-1",
)
print(result)

import Didit from "@didit-protocol/sdk-node";

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

const result = await didit.sessions.importShared({
  share_token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  trust_review: false,
  workflow_id: "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
  vendor_data: "user-1",
});
console.log(result);

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

result, err := client.Sessions.ImportShared(ctx, didit.SessionsImportSharedParams{
	ShareToken:  "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
	TrustReview: false,
	WorkflowID:  "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
	VendorData:  didit.String("user-1"),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.SessionsImportSharedParams;

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

var result = client.sessions().importShared(SessionsImportSharedParams.builder()
        .shareToken("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...")
        .trustReview(false)
        .workflowId("9f9b1234-aaaa-bbbb-cccc-1234567890ab")
        .vendorData("user-1")
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

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

$result = $didit->sessions->importShared([
    'share_token' => 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...',
    'trust_review' => false,
    'workflow_id' => '9f9b1234-aaaa-bbbb-cccc-1234567890ab',
    'vendor_data' => 'user-1',
]);
print_r($result->toArray());

require "didit"

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

result = didit.sessions.import_shared(
  share_token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  trust_review: false,
  workflow_id: "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
  vendor_data: "user-1"
)
puts result.to_h

using System;
using System.Text.Json;
using Didit;

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

var result = await client.Sessions.ImportSharedAsync(new SessionsImportSharedParams
{
    ShareToken = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    TrustReview = false,
    WorkflowId = "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
    VendorData = "user-1",
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "session_id": "11111111-2222-3333-4444-555555555555",
  "session_kind": "user",
  "shared_from_session": "99999999-8888-7777-6666-555555555555",
  "session_number": 43762,
  "session_url": null,
  "status": "In Review",
  "workflow_id": "9f9b1234-aaaa-bbbb-cccc-1234567890ab",
  "vendor_data": "user-1",
  "created_at": "2026-05-17T08:42:11Z",
  "expires_at": "2026-05-24T08:42:11Z"
}

KYC और KYB समर्थन

Didit share token को डिकोड करता है, उसमें एम्बेड किया गया session_kind पढ़ता है, और उसी प्रकार के सत्र का क्लोन बनाता है:

session_kind: "user": उपयोगकर्ता सत्र के साथ उससे जुड़ी पहचान, चेहरा, लाइवनेस, चेहरा मिलान, AML, स्थान, POA, फ़ोन, ईमेल, डेटाबेस सत्यापन और लॉग पंक्तियों का क्लोन बनाता है।
session_kind: "business": व्यवसाय सत्र के साथ उससे जुड़ी रजिस्ट्री जाँच, प्रमुख व्यक्तियों के रिकॉर्ड, दस्तावेज़, AML स्क्रीनिंग, फ़ोन, ईमेल, स्थान, प्रश्नावली और लॉग पंक्तियों का क्लोन बनाता है।

यदि token एकीकृत साझाकरण रोलआउट से पहले का है और उसमें session_kind फ़ील्ड नहीं है, तो पिछली संगतता के लिए Didit डिफ़ॉल्ट रूप से "user" मान लेता है।

क्या बनाया जाता है

आपके एप्लिकेशन में उसी प्रकार का एक नया सत्र, जिसमें नए session_id, session_number और session_url होंगे।
नए सत्र का shared_from_session फ़ील्ड स्रोत एप्लिकेशन के मूल सत्र की ओर इंगित करता है।
नए सत्र की स्थिति या तो मूल स्थिति होगी (trust_review: true) या IN_REVIEW (trust_review: false)।
यदि vendor_data के लिए कोई इकाई (उपयोगकर्ता या व्यवसाय) मौजूद नहीं है, तो वह अपने-आप बना दी जाती है।

उदाहरण

उपयोगकर्ता सत्यापन (KYC) सत्र आयात करें
व्यवसाय सत्यापन (KYB) सत्र आयात करें

curl -X POST https://verification.didit.me/v3/session/import-shared/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "share_token": "eyJhbGciOiJIUzI1NiJ9...",
    "workflow_id": "your-kyc-workflow-id",
    "vendor_data": "partner-user-42",
    "trust_review": false
  }'

रिस्पॉन्स (201 बनाया गया):

{
  "session_id": "new-uuid",
  "session_kind": "user",
  "shared_from_session": "original-uuid",
  "status": "In Review",
  "vendor_data": "partner-user-42",
  "id_verifications": [...],
  "liveness_checks": [...],
  "...": "..."
}

curl -X POST https://verification.didit.me/v3/session/import-shared/ \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "share_token": "eyJhbGciOiJIUzI1NiJ9...",
    "workflow_id": "your-kyb-workflow-id",
    "vendor_data": "partner-biz-acme",
    "trust_review": true
  }'

रिस्पॉन्स (201 बनाया गया):

{
  "session_id": "new-uuid",
  "session_kind": "business",
  "shared_from_session": "original-uuid",
  "status": "Approved",
  "vendor_data": "partner-biz-acme",
  "registry_checks": [...],
  "key_people_checks": [...],
  "document_verifications": [...],
  "...": "..."
}

`trust_review` पैरामीटर

मान	प्रभाव
`true`	आयात किया गया सत्र मूल स्थिति (जैसे `APPROVED`) बनाए रखता है। इसका उपयोग तभी करें जब आप साझा करने वाले पार्टनर के निर्णय पर पूरा भरोसा करते हों।
`false`	आयात किया गया सत्र `IN_REVIEW` में चला जाता है, ताकि कोई कार्रवाई करने से पहले आपकी टीम फिर से समीक्षा कर सके। बाहरी पार्टनर के लिए यह सुरक्षित डिफ़ॉल्ट है।

त्रुटियाँ

स्थिति	कारण
`400`	`share_token` अमान्य है, समय-सीमा समाप्त हो चुका है, किसी दूसरे एप्लिकेशन के लिए जारी किया गया है, या ऐसे सत्र की ओर इंगित करता है जिसे हटा दिया गया है। संदेश `share_token` कुंजी के अंतर्गत होता है।
`403`	सत्र पहले ही आपके एप्लिकेशन में आयात किया जा चुका है।
`404`	`workflow_id` आपके एप्लिकेशन का वर्कफ़्लो नहीं है।

आइडेम्पोटेंसी

एक ही एप्लिकेशन में एक ही share_token को दो बार आयात करने का प्रयास 403 के साथ अस्वीकार कर दिया जाता है, चाहे वह उपयोगकर्ता सत्र हो या व्यवसाय सत्र।

आपकी एप्लिकेशन की 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।

बॉडी

application/json

POST /v3/session/{sessionId}/share/ द्वारा जारी किया गया JWT शेयर टोकन।

उदाहरण:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

trust_review

boolean

आवश्यक

यदि true है, तो क्लोन किया गया सत्र स्रोत की अंतिम status बनाए रखता है। यदि false है, तो इसे In Review में डाल दिया जाता है।

उदाहरण:

false

workflow_id

string<uuid>

आवश्यक

कॉल करने वाले एप्लिकेशन में किसी वर्कफ़्लो का UUID। क्रॉस-एप्लिकेशन ID को 404 के साथ अस्वीकार कर दिया जाता है।

उदाहरण:

"9f9b1234-aaaa-bbbb-cccc-1234567890ab"

vendor_data

string | null

क्लोन किए गए सत्र के vendor_data के लिए वैकल्पिक ओवरराइड।

उदाहरण:

"user-1"

प्रतिक्रिया

सत्र क्लोन किया गया। बॉडी दोनों प्रकारों के लिए V3 निर्णय payload है, जिसे session_kind द्वारा अलग किया गया है: id_verifications, liveness_checks, aml_screenings जैसे सूची-आधारित सुविधा ब्लॉकों के साथ "user" (KYC); registry_checks और key_people_checks जैसे ब्लॉकों के साथ "business" (KYB)। दोनों में shared_from_session शामिल है — स्रोत एप्लिकेशन में मूल सत्र का session_id। trust_review: false के साथ क्लोन किए गए सत्र का status जबरन In Review पर सेट किया जाता है।

session_id

string<uuid>

सत्र का विशिष्ट पहचानकर्ता।

session_kind

enum<string>

यह इंगित करने वाला डिस्क्रिमिनेटर कि यह उपयोगकर्ता सत्यापन (KYC) सत्र है या व्यवसाय सत्यापन (KYB) सत्र। जब user हो, तो KYC फ़ीचर ऐरे (id_verifications, nfc_verifications, liveness_checks, face_matches, poa_verifications, document_ai_documents, database_validations, ...) लागू होते हैं और व्यावसायिक ऐरे अनुपस्थित होते हैं। जब business हो, तो payload में registry_checks, document_verifications, key_people_checks के साथ-साथ साझा ऐरे (aml_screenings, phone_verifications, email_verifications, ip_analyses, questionnaire_responses) शामिल होते हैं। include=events पास होने पर छोड़ दिया जाता है — events संरचना केवल उपयोगकर्ता सत्रों के लिए मौजूद होती है, इसलिए उस वेरिएंट से डिस्क्रिमिनेटर हटा दिया जाता है।

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

user,

business

shared_from_session

string<uuid> | null

POST /v3/session/import-shared/ के साथ क्लोन किए गए सत्र के लिए: स्रोत एप्लिकेशन में मूल सत्र का session_id। अन्य सभी सत्रों के लिए null। include=events पास किए जाने पर छोड़ दिया जाता है।

shared_from_session_number

integer | null

स्रोत सत्र का session_number जब इस सत्र को आपके संगठन के किसी अन्य एप्लिकेशन से इंपोर्ट किया गया था। अन्यथा null।

session_number

integer | null

सत्र की संख्या।

session_url

string<uri> | null

सत्र का URL।

status

enum<string>

सत्र की समग्र जीवनचक्र स्थिति — समेकित वर्कफ़्लो परिणाम। अंतिम मान Approved, Declined, In Review, Expired, Kyc Expired, और Abandoned हैं; Not Started, In Progress, Awaiting User, और Resubmitted इंगित करते हैं कि सत्र अभी भी वर्कफ़्लो से गुज़र रहा है।

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

Not Started,

In Progress,

Awaiting User,

In Review,

Approved,

Declined,

Resubmitted,

Expired,

Kyc Expired,

Abandoned

status_override

object | null

समीक्षक द्वारा मैन्युअल रूप से status सेट किए जाने पर मौजूद होता है। स्थिति स्वचालित होने पर null होता है। इसका उपयोग मैन्युअल स्वीकृति को स्वचालित स्वीकृति से अलग पहचानने के लिए करें।

Show child attributes

decision_trace

object

स्थिति तक कैसे पहुँचा गया: इसे किसने सेट किया और किन चेतावनियों ने ऐसा किया।

Show child attributes

linked_records

object | null

सत्र से जुड़े अन्य रिकॉर्ड का सारांश। दिखाने के लिए कुछ न होने पर, और उन वर्कफ़्लो के लिए जो आयु आश्वासन मानक घोषित करते हैं, null होता है।

Show child attributes

workflow_id

string<uuid> | null

वर्कफ़्लो समूह का स्थिर पहचानकर्ता जिसने यह सत्र बनाया। वर्कफ़्लो संस्करणित होते हैं — यह मान विशिष्ट संस्करण की नहीं, बल्कि स्वयं वर्कफ़्लो की पहचान करता है।

features

string[]

इस सत्र के लिए कॉन्फ़िगर की गई सत्यापन सुविधाओं की सूची, प्रदर्शन नामों के रूप में: ID_VERIFICATION, NFC, LIVENESS, FACE_MATCH, POA, PHONE, EMAIL_VERIFICATION, AML, IP_ANALYSIS, DATABASE_VALIDATION, QUESTIONNAIRE, AGE_ESTIMATION, FACE_SEARCH, GEOLOCATION (स्थान सत्यापन) (व्यवसाय सत्यापन सत्र KYB सुविधा सेट का उपयोग करते हैं: KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE, AML, PHONE, EMAIL_VERIFICATION, IP_ANALYSIS, QUESTIONNAIRE)। include=events के साथ प्रत्येक प्रविष्टि एक सादे स्ट्रिंग के बजाय एक ऑब्जेक्ट {feature, node_id} बन जाती है, और ईमेल सुविधा का नाम बदल दिया जाता है: यह यहाँ उपयोग किए गए EMAIL_VERIFICATION के बजाय इवेंट मोड में EMAIL के रूप में दिखाई देती है।

सत्र की सुविधा।

vendor_data

string | null

सत्र का वेंडर डेटा।

metadata

object | null

सत्र का मेटाडेटा।

expected_details

object | null

सत्र निर्माण के समय दिए गए अपेक्षित विवरण — निकाले गए डेटा (KYC) के विरुद्ध क्रॉस-सत्यापन के लिए या कंपनी रजिस्ट्री खोज (KYB) को पहले से भरने के लिए उपयोग किए जाते हैं। जो कुंजियाँ प्रदान की गई थीं, उन्हें ठीक वैसे ही लौटाता है; कोई प्रदान न किए जाने पर null। KYC सत्रों में व्यक्ति के फ़ील्ड होते हैं; व्यवसाय (KYB) सत्रों में company_name, registry_country और registration_number होते हैं।

Show child attributes

contact_details

object | null

सत्र बनाते समय प्रदान किए गए संपर्क विवरण (अधिसूचना ईमेल, पहले से भरे फ़ोन/ईमेल सत्यापन और संचार भाषा के लिए उपयोग किए जाते हैं)। जब न तो कोई ईमेल और न ही कोई फ़ोन नंबर प्रदान किया गया था, तब null होता है।

Show child attributes

callback

string<uri> | null

सत्र का कॉलबैक URL।

id_verifications

object[] | null

वर्कफ़्लो ग्राफ़ में पहचान-दस्तावेज़ चरणों द्वारा निर्मित पहचान सत्यापन (OCR) रिपोर्टों की ऐरे। हमेशा एक JSON ऐरे — id_verifications[0] पढ़ें और पुनरावृति करें यदि आपका वर्कफ़्लो एक से अधिक पहचान जाँच चला सकता है (उदाहरण के लिए प्राथमिक जाँच और साथ ही स्टेप-अप)। तब तक null जब तक कम से कम एक पहचान चरण ने डेटा उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें node_id, सुविधा-स्तरीय status, निकाले गए दस्तावेज़ फ़ील्ड, छवि URLs, गुणवत्ता स्कोर, MRZ, पता पार्सिंग, क्रॉस-सत्र मिलान, और warnings[] शामिल हैं।

Show child attributes

nfc_skip_reason

enum<string> | null

NFC चिप सत्यापन क्यों नहीं चला, जब भी वर्कफ़्लो में NFC चरण शामिल होता है तब पॉप्युलेट होता है। NFC लंबित रहने या चिप वास्तव में पढ़े जाने पर null। मान: USER_SKIPPED - उपयोगकर्ता ने NFC-सक्षम डिवाइस पर छोड़ना चुना (allow_nfc_skip द्वारा अनुमत); DOCUMENT_WITHOUT_CHIP - दस्तावेज़ में कोई पठनीय NFC चिप नहीं है (ICAO 9303 इलेक्ट्रॉनिक दस्तावेज़ नहीं है); CHIP_CERTIFICATE_UNAVAILABLE - दस्तावेज़ की जारी अवधि को कवर करने वाला जारीकर्ता देश का हस्ताक्षर प्रमाणपत्र (CSCA) अनुपलब्ध है, इसलिए चिप हस्ताक्षर सत्यापित नहीं किया जा सकता; DEVICE_WITHOUT_NFC - डिवाइस ने कोई NFC रीडर रिपोर्ट नहीं किया; INTEGRATION_WITHOUT_NFC_ACCESS - सत्यापन मूल SDK के बिना चला (उदा. वेब ब्राउज़र में), जिसके पास फ़ोन के NFC रीडर तक कोई पहुँच नहीं है; MRZ_KEY_UNAVAILABLE - चिप एक्सेस कुंजी दस्तावेज़ के MRZ से प्राप्त नहीं की जा सकी; JPKI_UNAVAILABLE - दस्तावेज़ जापान का माय नंबर कार्ड है, जिसकी चिप JPKI के माध्यम से पढ़ी जाती है, और इस सत्यापन के लिए JPKI उपलब्ध नहीं था: यह सक्षम नहीं है, या ऐप का मूल SDK माय नंबर कार्ड नहीं पढ़ सकता है।

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

USER_SKIPPED,

DOCUMENT_WITHOUT_CHIP,

CHIP_CERTIFICATE_UNAVAILABLE,

DEVICE_WITHOUT_NFC,

INTEGRATION_WITHOUT_NFC_ACCESS,

MRZ_KEY_UNAVAILABLE,

JPKI_UNAVAILABLE

nfc_verifications

object[] | null

वर्कफ़्लो ग्राफ़ में NFC चरणों द्वारा निर्मित NFC / ePassport रिपोर्टों का Array। यह हमेशा एक JSON array होता है, कभी भी एकल nfc ऑब्जेक्ट नहीं — nfc_verifications[0] पढ़ें और पुनरावृति (iterate) करें यदि आपका वर्कफ़्लो NFC को एक से अधिक बार चला सकता है। तब तक null जब तक कम से कम एक NFC चरण ने डेटा उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें node_id, सुविधा-स्तरीय status, chip_protocol, chip_data, authenticity (SOD + DG अखंडता), certificate_summary, और warnings[] शामिल हैं। जापान माय नंबर कार्ड को ICAO 9303 के बजाय JPKI के माध्यम से पढ़ा जाता है: इसके आइटम में chip_protocol: "jpki" होता है, यह अपने साक्ष्य jpki के तहत रखता है, और ICAO फ़ील्ड को null छोड़ता है। जब NFC चरण को ऑफ़र किए जाने से पहले ही बायपास कर दिया गया था (चिप रहित दस्तावेज़, अनुपलब्ध प्रमाणपत्र, कोई NFC क्षमता रिपोर्ट नहीं की गई, अपठनीय MRZ कुंजी, माय नंबर कार्ड के लिए JPKI अनुपलब्ध), तो यह null रहता है और nfc_skip_reason बताता है कि ऐसा क्यों हुआ; चरण में ही छोड़ दिया जाना (उपयोगकर्ता ने स्किप टैप किया, या स्कैन के समय रीडर अनुपलब्ध निकला) फिर भी is_nfc_skipped: true के साथ एक रिपोर्ट उत्पन्न करता है।

Show child attributes

liveness_checks

object[] | null

वर्कफ़्लो ग्राफ़ में लाइवनेस चरणों द्वारा निर्मित लाइवनेस रिपोर्टों का ऐरे। हमेशा एक JSON ऐरे — कभी भी एकल liveness ऑब्जेक्ट नहीं। तब तक null जब तक कम से कम एक लाइवनेस चरण ने डेटा उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें node_id, सुविधा-स्तरीय status, method, score, reference_image, video_url, वैकल्पिक age_estimation, क्रॉस-सत्र matches[], और warnings[] शामिल हैं।

Show child attributes

face_matches

object[] | null

वर्कफ़्लो ग्राफ़ में चेहरा मिलान चरणों द्वारा निर्मित चेहरा मिलान रिपोर्टों की ऐरे। हमेशा एक JSON ऐरे — कभी भी एकल face_match ऑब्जेक्ट नहीं। तब तक null जब तक कम से कम एक चेहरा मिलान चरण ने डेटा उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें node_id, सुविधा-स्तरीय status, समानता score, source_image, target_image, और warnings[] शामिल हैं।

Show child attributes

phone_verifications

object[] | null

फ़ोन सत्यापन रिपोर्टों की ऐरे — हमेशा एक JSON ऐरे, कभी भी एकल phone ऑब्जेक्ट नहीं। तब तक null जब तक कम से कम एक फ़ोन चरण ने डेटा उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें node_id, सुविधा-स्तरीय status, फ़ोन नंबर और देश का मेटाडेटा, lifecycle[], matches[], और warnings[] शामिल हैं।

Show child attributes

email_verifications

object[] | null

ईमेल सत्यापन रिपोर्टों की ऐरे — हमेशा एक JSON ऐरे, कभी भी एकल email ऑब्जेक्ट नहीं। तब तक null जब तक कम से कम एक ईमेल चरण ने डेटा उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें node_id, सुविधा-स्तरीय status, ईमेल पता, ब्रीच डेटा, lifecycle[], matches[], और warnings[] शामिल हैं।

Show child attributes

poa_verifications

object[] | null

पते का प्रमाण (POA) रिपोर्टों की ऐरे — हमेशा एक JSON ऐरे, कभी भी एकल poa ऑब्जेक्ट नहीं। तब तक null जब तक कम से कम एक POA चरण ने डेटा उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें node_id, सुविधा-स्तरीय status, दस्तावेज़ फ़ाइल URL, जारीकर्ता, तिथियाँ, पार्स किया गया पता, और warnings[] शामिल हैं।

Show child attributes

document_ai_documents

object[] | null

वर्कफ़्लो नोड द्वारा समूहीकृत Document AI रिपोर्टें — हमेशा एक JSON ऐरे, कभी भी एकल ऑब्जेक्ट नहीं। तब तक null जब तक कि कम से कम एक Document AI चरण ने डेटा उत्पन्न न किया हो। केवल तभी मौजूद होता है जब session_kind = user हो। प्रत्येक आइटम एक नोड समूह होता है जिसमें एक समग्र status, node_id, प्रति-दस्तावेज़ परिणामों (कॉन्फ़िगर की गई फ़ील्ड कुंजी द्वारा अनुक्रमित निष्कर्षण डेटा) का एक items[] ऐरे, और warnings शामिल होते हैं।

Show child attributes

questionnaire_responses

object[] | null

प्रश्नावली प्रतिक्रिया रिपोर्टों की ऐरे — हमेशा एक JSON ऐरे, कभी भी एकल questionnaire ऑब्जेक्ट नहीं। तब तक null जब तक कम से कम एक प्रश्नावली चरण ने डेटा उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें node_id, प्रश्नावली मेटाडेटा, फ़ॉर्म तत्वों वाले अनुभाग, और उपयोगकर्ता के उत्तर शामिल हैं।

Show child attributes

bank_verifications

object[] | null

उपयोगकर्ता और व्यवसाय सत्यापन के लिए, प्रति बैंक सत्यापन चरण एक आइटम के साथ बैंक सत्यापन परिणाम। जब तक कोई चरण परिणाम नहीं देता, तब तक null। प्रत्येक आइटम की method बताती है कि खाते का सत्यापन कैसे किया गया था: open_banking (बैंक साइन-इन) या account_lookup (खाता जाँच), या statement अथवा microdeposits फ़ॉलबैक, और none जब किसी प्रयास का मूल्यांकन होने से पहले व्यक्ति बैंक के बिना आगे बढ़ गया (continued_without_bank)। देखें बैंक सत्यापन विधियाँ।

Show child attributes

signatures

object[]

उपयोगकर्ता और व्यवसाय सत्यापन के लिए प्रति हस्ताक्षरकर्ता और हस्ताक्षर चरण एक आइटम के साथ ई-हस्ताक्षर परिणाम। केवल तभी मौजूद होता है जब वर्कफ़्लो में ई-हस्ताक्षर चरण हो; हस्ताक्षरकर्ता के उस चरण तक पहुँचने तक एक खाली ऐरे। ई-हस्ताक्षर रिपोर्ट देखें।

Show child attributes

aml_screenings

object[] | null

AML स्क्रीनिंग रिपोर्टों की ऐरे — हमेशा एक JSON ऐरे, कभी भी एकल aml ऑब्जेक्ट नहीं। तब तक null जब तक कम से कम एक AML चरण ने डेटा तैयार न किया हो। प्रत्येक आइटम पूरी रिपोर्ट है, जिसमें node_id, फ़ीचर-स्तरीय status, total_hits, entity_type, hits[], score, screened_data, is_ongoing_monitoring_enabled, और warnings[] शामिल हैं।

Show child attributes

ip_analyses

object[] | null

डिवाइस और IP विश्लेषण रिपोर्टों की ऐरे — हमेशा एक JSON ऐरे, कभी भी एकल ip_analysis ऑब्जेक्ट नहीं। तब तक null जब तक कम से कम एक IP-विश्लेषण चरण ने डेटा उत्पन्न न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें node_id, सुविधा-स्तरीय status, IP और जियोलोकेशन डेटा, डिवाइस फ़िंगरप्रिंट, और warnings[] शामिल हैं। डुप्लिकेट (node_id, ip_address, device_fingerprint) वाली प्रविष्टियों को सर्वर-साइड पर डिडुप्लिकेट किया जाता है।

Show child attributes

geolocation_checks

object[] | null

स्थान सत्यापन परिणामों का Array, प्रति स्थान सत्यापन चरण एक: उस चरण का स्वीकृत प्रयास। तब तक null जब तक कि किसी स्थान सत्यापन चरण ने डेटा उत्पन्न न किया हो। उसी चरण के पिछले प्रयास geolocation_attempts में हैं।

Show child attributes

geolocation_attempts

object[] | null

इस सत्र के प्रत्येक स्थान सत्यापन चरण का प्रत्येक प्रयास, सबसे पुराना पहले। पुनः सबमिशन द्वारा प्रतिस्थापित किए गए प्रयासों को छोड़ दिया गया है। एक वर्कफ़्लो जो अपनी रिस्पॉन्स विशेषताओं के माध्यम से geolocation_checks को रोकता है, वह इस सूची को भी रोकता है।

Show child attributes

database_validations

object[] | null

डेटाबेस सत्यापन रिपोर्टों की Array — हमेशा एक JSON array, कभी भी एकल database_validation ऑब्जेक्ट नहीं। null जब तक कि कम से कम एक DB सत्यापन चरण ने डेटा जनरेट न किया हो। प्रत्येक आइटम पूर्ण रिपोर्ट है, जिसमें node_id, सुविधा-स्तरीय status, screened_data, प्रति-सेवा validations[] (प्रत्येक अपने रजिस्ट्री source_data के साथ), और warnings[] शामिल हैं। screened_data और source_data फ़ील्ड देश के अनुसार भिन्न होते हैं:

ARG (अर्जेंटीना): screened_data: {document_number, selfie, gender, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, date_of_death, tax_id, tax_id_type, face_match_score, sit_1_since, banks, last_position, highest_position, rejected_checks}। RENAPER बायोमेट्रिक चेहरा मिलान सत्यापन का उपयोग करता है। दस्तावेज़ में मौजूद न होने पर (उदा. ड्राइविंग लाइसेंस) लिंग का स्वचालित रूप से चेहरे के विश्लेषण या दिए गए नाम से अनुमान लगाया जाता है

BOL (बोलीविया): screened_data: {document_number, date_of_birth, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, gender}

BRA (ब्राज़ील): screened_data: {tax_number, first_name, last_name, date_of_birth}. सफल CPF मिलानों के लिए source_data में हमेशा {identification_number, first_name, last_name, date_of_birth, lgpd_minor, minor_under_18, minor_under_16} शामिल होता है। सफल वयस्क लुकअप उन फ़्लैग्स को false पर सेट करते हैं। Receita Federal Consulta CPF सेवा LGPD-रोके गए डेटा के साथ HTTP 422 (18 वर्ष से कम उम्र का नाबालिग) या 451 (16 वर्ष से कम उम्र) लौटा सकती है; ऐसे मामलों में source_data नाबालिग फ़्लैग्स को आवश्यकतानुसार true पर सेट करता है, अपस्ट्रीम HTTP स्थिति शामिल करता है, और फ़ील्ड-स्तरीय सत्यापन no_match होता है। पूर्ण कोड सूची के लिए डेटाबेस सत्यापन परिणाम कोड संदर्भ का ब्राज़ील अनुभाग देखें।

CHL (चिली): screened_data: {personal_number, first_name, last_name, date_of_birth}. source_data: {identification_number, first_name, last_name, date_of_birth, gender}

COL (कोलंबिया): screened_data: {document_number, document_type, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, document_type}

CRI (कोस्टा रिका): screened_data: {personal_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}

DOM (डोमिनिकन गणराज्य): screened_data: {personal_number}. source_data: {identification_number} (केवल valid/invalid लौटाता है)

ECU (इक्वाडोर): screened_data: {personal_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, street, formatted_address, gender, nationality, education, marital_status, spouse, mother_name, father_name, profession}

ESP (स्पेन): screened_data: {personal_number, document_type, expiration_date, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, document_type, expiration_date}

GTM (ग्वाटेमाला): screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}

HND (होंडुरास): screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}

MEX (मेक्सिको): screened_data: {personal_number (CURP), first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, date_of_birth, gender, nationality, curp_status, state_of_birth, doc_probatorio, registration_year, registration_state, registration_municipality, num_acta, crip, issuing_state_code, foreign_registry_number, folio_carta, folio_certificado}। RENAPO सिविल रजिस्ट्री का उपयोग करता है। एक अतिरिक्त एक-एक करके सत्यापन के रूप में MEX के लिए एक अलग INE वैधता-जाँच सेवा भी उपलब्ध है।

PAN (पनामा): screened_data: {personal_number, selfie}. source_data: {identification_number}। SIB बायोमेट्रिक सत्यापन का उपयोग करता है

PER (पेरू): screened_data: {personal_number (DNI), first_name, last_name}. source_data: {identification_number, first_name, last_name, paternal_name, maternal_name, verification_number, verification_letter}

PRY (पैराग्वे): screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}

SLV (अल सल्वाडोर): screened_data: {document_number, date_of_birth, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}

URY (उरुग्वे): screened_data: {personal_number, date_of_birth, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name}

VEN (वेनेजुएला): screened_data: {document_number, first_name, last_name}. source_data: {identification_number, first_name, last_name, full_name, gender, date_of_birth, document_type}

Show child attributes

database_validation_not_performed_reason

object | null

एक कॉन्फ़िगर किए गए डेटाबेस सत्यापन ने कोई परिणाम क्यों नहीं दिया, {code, message} और संदर्भ फ़ील्ड के रूप में। केवल तभी मौजूद होता है जब उस चरण वाले वर्कफ़्लो के लिए database_validations, null हो, ताकि आप "रजिस्ट्री सहमत थी" को "कुछ नहीं चला" से अलग पहचान सकें। अन्यथा null।

Show child attributes

reviews

object[]

Show child attributes

assignee

object | null

कंसोल समीक्षक जिसे सत्र सौंपा गया है, या null जब इसे कोई नहीं संभाल रहा हो।

Show child attributes

waiting_since

string<date-time> | null

सत्र समीक्षा की प्रतीक्षा कब करने लगा। null जब तक कि सत्र In Review में न हो और आपका एप्लिकेशन समीक्षा समय-सीमा निर्धारित करे।

sla_due_at

string<date-time> | null

समीक्षा कब नियत है। null जब तक कि सत्र In Review में न हो और आपका एप्लिकेशन समीक्षा समय-सीमा निर्धारित न करे।

created_at

string<date-time>

सत्र बनाए जाने का टाइमस्टैम्प (ISO 8601, UTC)।

expires_at

string<date-time> | null

वह टाइमस्टैम्प जब इस सत्र की समय-सीमा समाप्त होने का शेड्यूल है। उपयोगकर्ता सत्यापन (KYC) सत्रों पर तब सेट किया जाता है जब निर्माण के समय समाप्ति कॉन्फ़िगर की गई हो (या जब Approved स्थिति KYC समाप्ति गणना को ट्रिगर करती है)। बिना कॉन्फ़िगर की गई समाप्ति वाले सत्रों के लिए, और उन प्रकारों के लिए जो समाप्ति का उपयोग नहीं करते हैं (उदा. व्यवसाय सत्यापन (KYB) सत्र जिन्हें कभी expires_at प्राप्त नहीं हुआ) null।

registry_checks

object[] | null

कंपनी रजिस्ट्री जांच। केवल तभी मौजूद होती है जब session_kind = business हो। प्रत्येक आइटम संपूर्ण कंपनी-रजिस्ट्री payload को समेटे रहता है।

Show child attributes

key_people_checks

object[] | null

प्रमुख व्यक्तियों की जाँच का समग्र परिणाम। केवल तभी उपस्थित होता है जब session_kind = business हो। प्रत्येक आइटम दो-बकेट संरचना (registry, submitted, ubo_kyc_summary) का उपयोग करता है।

Show child attributes

document_verifications

object[] | null

वर्कफ़्लो नोड के अनुसार समूहीकृत दस्तावेज़ सत्यापन जाँचें। केवल तब मौजूद होती हैं जब session_kind = business हो।

Show child attributes

environment

enum<string>

क्या सत्र किसी लाइव एप्लिकेशन (live) या सैंडबॉक्स एप्लिकेशन (sandbox) द्वारा बनाया गया था। सैंडबॉक्स सत्र निःशुल्क और पूरी तरह से सिम्युलेटेड होते हैं, और इनसे कभी भी क्रेडिट का शुल्क नहीं लिया जाता है।

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

live,

sandbox

sandbox_scenario

string | null

वह सैंडबॉक्स परिदृश्य जिसके साथ सत्र बनाया गया था। लाइव सत्रों के लिए और बिना किसी परिदृश्य के बनाए गए सैंडबॉक्स सत्रों के लिए null।

resubmissions

object[]

उपयोगकर्ता और व्यवसाय सत्रों के लिए केवल include=resubmissions के साथ लौटाया जाता है। प्रति पुनः सबमिशन अनुरोध पर एक प्रविष्टि, सबसे पुरानी पहले। प्रत्येक प्रविष्टि उन परिणामों को ले जाती है जो पुनः सबमिट किए गए चरणों ने अनुरोध से पहले लौटाए थे, ताकि पहले के सबमिशन पढ़े जा सकें। सत्र को हटाने से प्रत्येक सबमिशन डिलीट हो जाता है।

Show child attributes

क्या सत्र को फ़ेस कैप्चर से पहले स्पष्ट बायोमेट्रिक सहमति की आवश्यकता थी, क्यों, और उत्तर का साक्ष्य। केवल उपयोगकर्ता सत्यापन (KYC) सत्र; वही ऑब्जेक्ट सत्र webhooks के decision में होता है। null जब सत्र का कभी मूल्यांकन नहीं किया गया, उदाहरण के लिए बिना फ़ेस कैप्चर वाला वर्कफ़्लो। बिना किसी रिकॉर्ड किए गए मान वाले फ़ील्ड null होते हैं। 4.10.0 से नीचे का एक नेटिव SDK, या जो अपने संस्करण की रिपोर्ट नहीं करता है, सहमति चरण नहीं दिखा सकता है: इसके फ़ेस कैप्चर पहले की तरह चलते हैं, और जिस सत्र में सहमति की आवश्यकता थी वह फिर reason: "BIOMETRIC_CONSENT_UNSUPPORTED_SDK" के साथ status: "pending" रिपोर्ट करता है। देखें बायोमेट्रिक सहमति।

Show child attributes

investigator

object | null

आइटम की नवीनतम Investigator समीक्षा, या जब इसकी कभी कोई समीक्षा नहीं हुई हो तो null। V3 सत्र और व्यावसायिक सत्र के निर्णय (और इसलिए status.updated webhooks) द्वारा वहन किए जाते हैं।

Show child attributes

biometric_retention

object

इस सत्र का लाइव बायोमेट्रिक डेटा कब हटाया जाता है।

Show child attributes

fraud_check

object | null

एक Fraud Check API कॉल का परिणाम। हर दूसरे सत्र के लिए null।

full_session_video

string<uri> | null

पूर्ण-सत्र रिकॉर्डिंग का समाप्त होने वाला URL। केवल तभी लौटाया जाता है जब आपका संगठन पूर्ण-सत्र वीडियो रिकॉर्ड करता है।

full_session_video_recorded_at

string<date-time> | null

जब पूर्ण-सत्र रिकॉर्डिंग की गई थी। केवल तब लौटाया जाता है जब आपका संगठन पूर्ण-सत्र वीडियो रिकॉर्ड करता है।

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

​KYC और KYB समर्थन

​क्या बनाया जाता है

​उदाहरण

​trust_review पैरामीटर

​त्रुटियाँ

​आइडेम्पोटेंसी

​संबंधित

प्राधिकरण

बॉडी

प्रतिक्रिया

KYC और KYB समर्थन

क्या बनाया जाता है

उदाहरण

`trust_review` पैरामीटर

त्रुटियाँ

आइडेम्पोटेंसी

संबंधित