मुख्य सामग्री पर जाएं
POST
cURL

प्राधिकरण

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
document
file
आवश्यक

पते का प्रमाण दस्तावेज़। स्वीकृत एक्सटेंशन: tiff, jpg, jpeg, png, pdf, webp। अधिकतम अपलोड साइज़: 15 MB (बड़ी फ़ाइलें 400 के साथ अस्वीकृत कर दी जाती हैं)। मल्टी-पेज PDF समर्थित हैं (अधिक लेटेंसी की उम्मीद करें); एन्क्रिप्टेड PDF के लिए document_password आवश्यक है। प्रोसेसिंग से पहले इमेज स्वचालित रूप से कंप्रेस की जाती हैं।

document_password
string
write-only

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

expected_address
string

दस्तावेज़ के साथ सत्यापित करने के लिए पता। इसे जियोकोड किया जाता है और निकाले गए पते से तुलना की जाती है; बेमेल होने पर (या ऐसा अपेक्षित पता जिसे जियोकोड/सत्यापित नहीं किया जा सकता) ADDRESS_MISMATCH_WITH_PROVIDED जुड़ जाता है, जो poa_address_mismatch_action द्वारा नियंत्रित होता है। जियोकोड किया गया रूप expected_details_formatted_address / expected_details_parsed_address में वापस दिखाया जाता है।

उदाहरण:

"Av. Monseñor Tavella 1291, Salta, Argentina"

expected_country
string

दस्तावेज़ से सत्यापित करने के लिए देश (ISO 3166-1 कोड, उदा. ARG या AR)। दस्तावेज़ के देश के साथ बेमेल होने पर POA_COUNTRY_MISMATCH_WITH_PROVIDED जुड़ जाता है, जो poa_address_mismatch_action द्वारा नियंत्रित होता है।

उदाहरण:

"ARG"

expected_first_name
string

name_on_document के विरुद्ध सत्यापित करने के लिए पहला नाम (फ़ज़ी मिलान, लिप्यंतरण-सचेत)। मिलान थ्रेशोल्ड से नीचे का स्कोर NAME_MISMATCH_WITH_PROVIDED जोड़ता है, जो poa_address_mismatch_action द्वारा नियंत्रित होता है।

उदाहरण:

"Sophia"

expected_last_name
string

name_on_document के विरुद्ध सत्यापित करने के लिए अंतिम नाम, मिलान स्कोर के लिए expected_first_name के साथ संयुक्त।

उदाहरण:

"Martinez"

poa_languages_allowed
string

ISO 639-1 कोड के रूप में स्वीकृत दस्तावेज़ भाषाओं की कॉमा से अलग की गई सूची (उदा. en,es,fr)। छोड़े जाने या खाली होने पर, सभी 51 समर्थित भाषाएं स्वीकृत हैं। सूची से बाहर की भाषा में दस्तावेज़ UNSUPPORTED_DOCUMENT_LANGUAGE जोड़ता है (poa_unsupported_language_action द्वारा शासित); सूची में एक अज्ञात कोड समर्थित कोड के पूरे सेट के साथ 400 लौटाता है।

उदाहरण:

"en,es"

poa_document_age_months
string

कॉमा से अलग किए गए key:value जोड़े जो प्रति दस्तावेज़ प्रकार महीनों में अधिकतम दस्तावेज़ आयु निर्धारित करते हैं — कुंजियाँ: utility_bill, bank_statement, government_issued_document, other_poa_document; मान: 1–120, या असीमित (कोई आयु जांच नहीं) के लिए -1। छोड़े जाने पर डिफ़ॉल्ट: utility_bill:3,bank_statement:3,government_issued_document:12,other_poa_document:12। अपनी सीमा से पुराना दस्तावेज़ POA_DOCUMENT_EXPIRED के साथ अस्वीकृत हो जाता है। सावधानी: जब आप यह फ़ील्ड प्रदान करते हैं, तो आपके द्वारा स्वीकार किए जाने वाले प्रत्येक प्रकार को सूचीबद्ध करें — छोड़े गए प्रकारों को अस्वीकृत माना जाता है (सूचनात्मक POA_DOCUMENT_NOT_SUPPORTED_FOR_APPLICATION) और उनकी आयु जांच छोड़ दी जाती है।

उदाहरण:

"utility_bill:3,bank_statement:6"

poa_name_mismatch_action
enum<string>
डिफ़ॉल्ट:DECLINE

स्वीकृत लेकिन वर्तमान में लागू नहीं किया गया — नाम-बेमेल चेतावनियाँ (NAME_MISMATCH_WITH_PROVIDED) इसके बजाय poa_address_mismatch_action का पालन करती हैं। नाम और पते दोनों के बेमेल व्यवहार को नियंत्रित करने के लिए poa_address_mismatch_action सेट करें।

उपलब्ध विकल्प:
DECLINE,
NO_ACTION
poa_document_issues_action
enum<string>
डिफ़ॉल्ट:DECLINE

फ़ाइल-अखंडता समस्याओं पर क्या कार्रवाई करें — व्यवहार में इस endpoint द्वारा केवल DOCUMENT_METADATA_MISMATCH ही उत्पन्न होता है।

उपलब्ध विकल्प:
DECLINE,
NO_ACTION
poa_document_authenticity_action
enum<string>
डिफ़ॉल्ट:DECLINE

दस्तावेज़ में हेरफेर का संदेह होने पर क्या कार्रवाई करें (SUSPECTED_DOCUMENT_MANIPULATION) — उदाहरण के लिए, PDF को डिजिटल हस्ताक्षर के बाद संशोधित किया गया था, किसी ज्ञात PDF संपादक द्वारा संसाधित किया गया था, ओवरले-टेक्स्ट हेरफेर दिखाता है, या इसमें असंगत EXIF तिथियाँ हैं। POA_DOCUMENT_UNPROVEN_TEXT_REPLACEMENT को भी नियंत्रित करता है (एक पुनः टाइप किया गया टेक्स्ट फ़ील्ड जिसे फ़ाइल परिवर्तित या अपरिवर्तित साबित नहीं कर सकती): DECLINE इसे भी अस्वीकार करता है, NO_ACTION इसे चेतावनी के रूप में रखता है।

उपलब्ध विकल्प:
DECLINE,
NO_ACTION
poa_unsupported_language_action
enum<string>
डिफ़ॉल्ट:DECLINE

दस्तावेज़ की भाषा poa_languages_allowed से बाहर होने (UNSUPPORTED_DOCUMENT_LANGUAGE) पर क्या कार्रवाई की जाए।

उपलब्ध विकल्प:
DECLINE,
NO_ACTION
poa_address_mismatch_action
enum<string>
डिफ़ॉल्ट:DECLINE

निकाले गए विवरणों का expected_* फ़ील्ड से मेल न खाने पर क्या कार्रवाई की जाए: ADDRESS_MISMATCH_WITH_PROVIDED, NAME_MISMATCH_WITH_PROVIDED, और POA_COUNTRY_MISMATCH_WITH_PROVIDED सभी इसी कार्रवाई का पालन करते हैं।

उपलब्ध विकल्प:
DECLINE,
NO_ACTION
poa_issuer_not_identified_action
enum<string>
डिफ़ॉल्ट:DECLINE

जब दस्तावेज़ पर किसी जारीकर्ता कंपनी/संगठन की पहचान नहीं की जा सकती है (ISSUER_NOT_IDENTIFIED) तो क्या कार्रवाई करें।

उपलब्ध विकल्प:
DECLINE,
NO_ACTION
save_api_request
boolean
डिफ़ॉल्ट:true

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

उदाहरण:

true

vendor_data
string

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

उदाहरण:

"user-123"

metadata
object

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

उदाहरण:

प्रतिक्रिया

दस्तावेज़ संसाधित। poa.status Approved या Declined है; हर संसूचित समस्या को poa.warnings में सूचीबद्ध किया गया है। समय-सीमा समाप्त, बेमेल या संदिग्ध दस्तावेज़ भी status: "Declined" के साथ 200 लौटाता है — केवल HTTP कोड ही नहीं, बल्कि बॉडी का भी निरीक्षण करें। जब save_api_request=true हो, तो request_id स्थायी सत्र id होती है।

request_id
string<uuid>

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

poa
object
vendor_data
string | null

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

metadata
object | null

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

created_at
string<date-time>

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

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