मुख्य सामग्री पर जाएं
GET
curl
फ़ाइलें एक्सपोर्ट करें का उपयोग करके शुरू किए गए एक्सपोर्ट को पढ़ें।
  • PENDING और PROCESSING: ZIP तैयार की जा रही है। कुछ सेकंड बाद एक्सपोर्ट को फिर से पढ़ें।
  • READY: download_url ZIP का एक साइन किया गया लिंक है, जो थोड़े समय के लिए मान्य रहता है। expires_at तक एक्सपोर्ट को फिर से पढ़कर नया लिंक प्राप्त करें।
  • FAILED: ZIP तैयार नहीं की जा सकी। नया एक्सपोर्ट शुरू करें।
  • EXPIRED: ZIP हटा दी गई थी। नया एक्सपोर्ट शुरू करें।
डाउनलोड लिंक देने वाली हर रीड को सत्र के ऑडिट लॉग में दर्ज किया जाता है। हटाए गए सत्र का एक्सपोर्ट 404 लौटाता है।

प्राधिकरण

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।

पथ पैरामीटर

sessionId
string<uuid>
आवश्यक

सत्यापन सत्र का UUID (POST /v3/session/ द्वारा लौटाया गया session_id)। उपयोगकर्ता सत्यापन (KYC) और व्यवसाय सत्यापन (KYB) दोनों सत्र ID स्वीकार करता है। हटाया गया सत्र 404 लौटाता है।

उदाहरण:

"11111111-2222-3333-4444-555555555555"

exportId
string<uuid>
आवश्यक

POST /v3/session/{sessionId}/files-export/ द्वारा लौटाया गया export_id।

उदाहरण:

"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"

प्रतिक्रिया

एक्सपोर्ट।

मूल गुणवत्ता में, एक सत्र की प्रत्येक फ़ाइल के साथ एक ZIP।

export_id
string<uuid>
आवश्यक

एक्सपोर्ट की ID। इसे GET /v3/session/{sessionId}/files-export/{exportId}/ में पास करें।

session_id
string<uuid>
आवश्यक

वह सत्र जिससे फ़ाइलें संबंधित हैं।

status
enum<string>
आवश्यक

ZIP तैयार होने के दौरान PENDING और PROCESSING, डाउनलोड के लिए तैयार होने पर READY, तैयार न हो पाने पर FAILED (एक नए एक्सपोर्ट का अनुरोध करें), ZIP हटा दिए जाने पर EXPIRED।

उपलब्ध विकल्प:
PENDING,
PROCESSING,
READY,
FAILED,
EXPIRED
file_count
integer | null
आवश्यक

ZIP में मौजूद फ़ाइलें। केवल तभी सेट होती हैं जब status READY हो।

size_bytes
integer<int64> | null
आवश्यक

बाइट्स में ZIP का आकार। केवल तब सेट होता है जब status का मान READY हो।

download_url
string<uri> | null
आवश्यक

ZIP का हस्ताक्षरित URL, जो कम समय के लिए मान्य होता है। केवल तब सेट होता है जब status का मान READY हो; नया URL पाने के लिए एक्सपोर्ट को फिर से पढ़ें।

expires_at
string<date-time> | null
आवश्यक

जब ZIP को हटा दिया जाता है, इसके तैयार होने के 24 घंटे बाद। केवल तब सेट होता है जब status READY हो।

error
string | null
आवश्यक

एक्सपोर्ट क्यों विफल हुआ, जब status FAILED हो।

created_at
string<date-time>
आवश्यक

जब एक्सपोर्ट का अनुरोध किया गया था।

completed_at
string<date-time> | null
आवश्यक

जब ZIP तैयार हुआ था या एक्सपोर्ट विफल रहा था।

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