> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.
# KYC और KYB अनुपालन PDF रिपोर्ट API
> Didit का GET /v3/session/{id}/generate-pdf/ KYC या KYB सत्र की ब्रांडेड रिपोर्ट डाउनलोड करता है। व्हाइट लेबल, ऑडिट-तैयार, उपयोग-आधारित मूल्य।
PDF जनरेट करने का प्रॉम्प्ट
प्रॉम्प्ट को क्लिपबोर्ड पर कॉपी करें
\
\`Download an audit-ready PDF report for a finished Didit verification session.
Endpoint:
GET https://verification.didit.me/v3/session/{session_id}/generate-pdf/
Authentication:
Use the x-api-key header with your Didit API key (or a user-auth token). Privilege: read:sessions.
Path parameter:
\- session_id (UUID) — works for both User Verification (KYC) and Business Verification (KYB) sessions. Didit routes to the correct template automatically.
Prerequisites:
\- Session status must be one of "Approved", "Declined", "In Review". Any other status returns 403.
\- Session must belong to the authenticated application — cross-application reads return 404.
curl example — save the PDF to disk:
curl https://verification.didit.me/v3/session//generate-pdf/ \
-H "x-api-key: " \
-o report.pdf
Response:
\- Body is binary (application/pdf). DO NOT parse as JSON.
\- Content-Type: application/pdf
\- Content-Disposition: attachment; filename=session_.pdf for KYC sessions, business_.pdf for KYB sessions.
\- Typical wall time ~1-3s (server-side WeasyPrint rendering).
Template contents:
\- KYC PDF: Identity (OCR), Liveness, Face Match, AML, POA, IP analysis, reviews, events.
\- KYB PDF: Company registry data, officers, beneficial owners (UBOs), KYB documents, AML hits, questionnaires, phone verification, email verification, IP analysis, reviews, events.
White-label:
If white-label customization is enabled on your application, the PDF uses your logo and privacy-policy URL. Configure at Console → Customization.
Failure modes:
\- 401 — invalid credentials.
\- 403 — { "detail": "You do not have permission to perform this action." } when the key lacks read:sessions OR when the session is in a non-printable status (Not Started, In Progress, Expired, Abandoned, Kyc Expired, Resubmitted, Awaiting User).
\- 404 — { "detail": "Not found." } when the session is not visible to this application.
Idempotency & cost:
Safe to retry — generation is read-only. Counts against the standard rate limit.
When to call:
\- Compliance archives (regulator submissions, internal audit binders).
\- Customer support replies (proof of decision for a specific session).
\- After approve / decline via /sessions-api/update-status — render and store the resulting PDF.
\- For every session of one user in a single file, use GET /v3/users/{vendor_data}/generate-pdf/ instead (see /management-api/users/generate-pdf).
For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`
\
यहाँ पेस्ट करें
## KYC और KYB समर्थनयह **उपयोगकर्ता सत्यापन (KYC)** और **व्यवसाय सत्यापन (KYB)** दोनों प्रकार के सत्रों के लिए काम करता है। Didit स्वचालित रूप से उपयुक्त PDF टेम्पलेट चुनता है:- उपयोगकर्ता सत्यापन (KYC) सत्र → पहचान सत्यापन, लाइवनेस डिटेक्शन, चेहरा मिलान, AML और पते के प्रमाण (POA) अनुभागों वाली रिपोर्ट।
- व्यवसाय सत्यापन (KYB) सत्र → कंपनी रजिस्ट्री, प्रमुख व्यक्ति (UBO और अधिकारी), दस्तावेज़, AML, प्रश्नावली, फ़ोन, ईमेल और IP विश्लेषण अनुभागों वाली रिपोर्ट, जब ये सुविधाएँ वर्कफ़्लो का हिस्सा हों।दोनों एक ही PDF जनरेशन पाइपलाइन का उपयोग करते हैं और व्हाइट-लेबल कस्टमाइज़ेशन (लोगो, गोपनीयता नीति URL) का समर्थन करते हैं।## फ़ाइल नाम का नियम| प्रकार | फ़ाइल नाम |
| - | - |
| उपयोगकर्ता | `session_.pdf` |
| व्यवसाय | `business_.pdf` |यह `Content-Disposition: attachment; filename=...` हेडर के माध्यम से लौटाया जाता है।## स्थिति की आवश्यकताPDF जनरेट करने के लिए सत्र `APPROVED`, `DECLINED` या `IN_REVIEW` स्थिति में होना चाहिए। प्रगति में चल रहे या शुरू न किए गए सत्र `403` लौटाते हैं।## उदाहरण> [tab] उपयोगकर्ता सत्यापन (KYC) PDF
>
> ```bash theme={null}
> curl https://verification.didit.me/v3/session/4c5c7f3a-.../generate-pdf/ \
> -H "x-api-key: YOUR_API_KEY" \
> -o kyc-report.pdf
> ```> [tab] व्यवसाय सत्यापन (KYB) PDF
>
> ```bash theme={null}
> curl https://verification.didit.me/v3/session/bs-01HJX1.../generate-pdf/ \
> -H "x-api-key: YOUR_API_KEY" \
> -o kyb-report.pdf
> ```## व्हाइट-लेबलजब एप्लिकेशन में व्हाइट-लेबल कस्टमाइज़ेशन सक्षम होता है, तो PDF में आपके लोगो और गोपनीयता नीति URL का उपयोग किया जाता है। इसे *Console → Customization* में कॉन्फ़िगर करें।## अनुमतिइसके लिए `read:sessions` आवश्यक है। दोनों प्रकारों के लिए यही स्कोप लागू होता है।## संबंधित- [सत्र का अवलोकन](https://docs.didit.me/hi/sessions-api/overview.md)
- [सत्र प्राप्त करें](https://docs.didit.me/hi/sessions-api/retrieve-session.md) — उसी निर्णय का JSON संस्करण
- [उपयोगकर्ता इतिहास PDF डाउनलोड करें](https://docs.didit.me/hi/management-api/users/generate-pdf.md) — एक उपयोगकर्ता के सभी रिपोर्ट योग्य सत्र एक ही फ़ाइल में
- [KYB रिस्पॉन्स स्कीमा](https://docs.didit.me/hi/business-verification/response-schema.md) — व्यवसाय PDF में शामिल फ़ील्ड
## OpenAPI
````yaml hi/openapi-25.json GET /v3/session/{sessionId}/generate-pdf/
openapi: 3.0.0
info:
version: 3.0.0
title: Didit Verification API
description: पहचान सत्यापन API। x-api-key हेडर के साथ प्रमाणीकृत करें।
servers:
- url: https://verification.didit.me
security: []
tags: []
paths:
/v3/session/{sessionId}/generate-pdf/:
get:
tags:
- Sessions
summary: सत्यापन सत्र के लिए PDF रिपोर्ट डाउनलोड करें
description: >-
पूर्ण हो चुके सत्यापन सत्र के लिए अनुपालन-तैयार PDF रिपोर्ट रेंडर करें
और डाउनलोड करें। यही पाथ उपयोगकर्ता सत्यापन (KYC) और व्यवसाय सत्यापन
(KYB) दोनों सत्रों के लिए काम करता है — सर्वर दोनों सत्र प्रकारों के
विरुद्ध `sessionId` को हल करता है और मिलान वाले रिपोर्ट टेम्पलेट का चयन
करता है।
**पात्र स्थितियाँ।** सत्र में पहले से ही कोई अंतिम या समीक्षा योग्य
स्थिति होनी चाहिए:
- KYC सत्र: `Approved`, `Declined`, `In Review`, या `Kyc Expired`।
- KYB सत्र: `Approved`, `Declined`, या `In Review`।
कोई भी अन्य स्थिति (`Not Started`, `In Progress`, `Expired`,
`Abandoned`, …) व्याख्यात्मक `detail` स्ट्रिंग के साथ `403` लौटाती है —
नीचे `403` रिस्पॉन्स देखें।
**रिपोर्ट में क्या शामिल है।** PDF अनुरोध के समय कंसोल सत्र दृश्य को
दर्शाता है:
- **KYC** — संकलित सत्र स्थिति, चेतावनियों की सूची, और निष्पादित
प्रत्येक सुविधा के लिए एक अनुभाग: पहचान सत्यापन (दस्तावेज़ की छवियां और
निकाले गए फ़ील्ड), NFC, लाइवनेस, चेहरा मिलान, ईमेल सत्यापन, फ़ोन
सत्यापन, पते का प्रमाण, प्रश्नावली के उत्तर, डेटाबेस सत्यापन, AML
स्क्रीनिंग, और IP विश्लेषण — इसके बाद सत्र टैग, कंसोल समीक्षा गतिविधि
(टिप्पणियाँ और स्थिति परिवर्तन), और सत्र इवेंट की समयरेखा।
- **KYB** — रजिस्ट्री जांच (कंपनी डेटा), AML स्क्रीनिंग, व्यावसायिक
दस्तावेज़ सत्यापन, प्रमुख व्यक्तियों की जांच, प्रश्नावली प्रतिक्रियाएं,
फ़ोन/ईमेल सत्यापन, IP विश्लेषण, और सत्र इवेंट की समयरेखा, जिसके बाद टैग
और समीक्षा गतिविधि शामिल हैं।
**ब्रांडिंग।** यदि आपके एप्लिकेशन में व्हाइट लेबल कस्टमाइज़ेशन है, तो
रिपोर्ट आपके लोगो और आपकी गोपनीयता-नीति URL के लिंक के साथ रेंडर की जाती
है; अन्यथा इसमें Didit की ब्रांडिंग होती है। रिपोर्ट अंग्रेजी में रेंडर
की जाती हैं — कोई भाषा पैरामीटर नहीं है।
**कोई कैशिंग नहीं।** प्रत्येक कॉल वर्तमान सत्र डेटा से PDF को पुनः रेंडर
करती है, इसलिए मैन्युअल समीक्षा के बाद जनरेट की गई रिपोर्ट समीक्षक के
निर्णय को दर्शाती है। एक ही सत्र के लिए दो कॉल बाइट-अलग फ़ाइलें उत्पन्न
कर सकती हैं — यदि आपको एक अपरिवर्तनीय प्रतिलिपि की आवश्यकता है तो
डाउनलोड की गई फ़ाइल को संग्रहीत करें।
**विलंबता (Latency)।** PDF तैयार करने से पहले रेंडरिंग प्रत्येक संग्रहीत
छवि (दस्तावेज़ के दोनों पक्ष, सेल्फ़ी, अतिरिक्त फ़ाइलें) को डाउनलोड करती
है, इसलिए भारी मीडिया वाले सत्रों में कई सेकंड लग सकते हैं। उदार क्लाइंट
रीड टाइमआउट (60 सेकंड अनुशंसित) का उपयोग करें और बॉडी को डिस्क पर
स्ट्रीम करें।
**ट्रेलिंग स्लैश।** कैनोनिकल रूट एक ट्रेलिंग स्लैश (`…/generate-pdf/`)
के साथ समाप्त होता है। इसके बिना किया गया अनुरोध सीधे उसी रिस्पॉन्स के
साथ पूरा किया जाता है — कोई `301` रीडायरेक्ट नहीं होता है, इसलिए किसी भी
क्लाइंट को रीडायरेक्ट का पालन करने की आवश्यकता नहीं होती है और `curl` को
`-L` की आवश्यकता नहीं होती है। नमूनों की तरह स्लैश वाले URL का उपयोग
करें।
यदि आपको रेंडर की गई रिपोर्ट के बजाय अंतर्निहित डेटा JSON के रूप में
चाहिए, तो `GET /v3/session/{sessionId}/decision/` का उपयोग करें। एक ही
दस्तावेज़ में किसी एक उपयोगकर्ता के प्रत्येक रिपोर्ट योग्य सत्र के लिए,
`GET /v3/users/{vendor_data}/generate-pdf/` का उपयोग करें।
operationId: get_v3_session_generate_pdf
parameters:
- name: sessionId
in: path
required: true
description: >-
रेंडर किए जाने वाले उपयोगकर्ता सत्यापन (KYC) या व्यवसाय सत्यापन
(KYB) सत्र का UUID — `POST /v3/session/` द्वारा लौटाया गया
`session_id`। एक ही पाथ दोनों प्रकार के सत्रों के लिए काम करता है;
रिस्पॉन्स पर `Content-Disposition` फ़ाइल नाम का उपयोग करके पहचानें
कि आपको किस प्रकार की रिपोर्ट प्राप्त हुई है।
**यह एक सही प्रारूप वाला, लोअरकेस UUID होना चाहिए।** यह रूट केवल
मान्य UUID से मेल खाता है, इसलिए किसी भी एप्लिकेशन कोड के चलने से
पहले URL राउटर द्वारा विकृत मान को अस्वीकार कर दिया जाता है और
रिस्पॉन्स नीचे दिखाए गए JSON `{"detail": ...}` एनवलप के बजाय `404`
**HTML** पेज होता है। रूट का UUID कन्वर्टर केवल कैनोनिकल लोअरकेस
फ़ॉर्म से मेल खाता है — अपरकेस-हेक्स UUID को HTML 404 के साथ
अस्वीकार कर दिया जाता है।
schema:
type: string
format: uuid
example: 11111111-2222-3333-4444-555555555555
responses:
'200':
description: >-
रेंडर किया गया PDF दस्तावेज़, सीधे बाइनरी `application/pdf` के रूप
में लौटाया गया — कोई JSON रैपर नहीं है और कोई डाउनलोड-URL
इनडायरेक्शन नहीं है। बॉडी `%PDF` मैजिक बाइट्स (PDF 1.7) से शुरू होती
है। इसे `.pdf` फ़ाइल में सहेजें या अपने कॉलर को स्ट्रीम करें।
headers:
Content-Disposition:
description: >-
KYC सत्रों के लिए `attachment;
filename=session_{sessionId}.pdf`, KYB सत्रों के लिए
`attachment; filename=business_{sessionId}.pdf` — उपसर्ग बताता
है कि कौन सा रिपोर्ट टेम्पलेट रेंडर किया गया था।
schema:
type: string
example: >-
attachment;
filename=session_11111111-2222-3333-4444-555555555555.pdf
Content-Length:
description: बाइट्स में PDF का कुल आकार; बॉडी चंक नहीं की गई है।
schema:
type: integer
example: 25191
content:
application/pdf:
schema:
type: string
format: binary
'403':
description: >-
प्रमाणीकरण, प्राधिकरण, या सत्र-स्थिति विफलता। अनुपस्थित कुंजी `403`
लौटाती है; गलत, निरस्त या समय-सीमा समाप्त कुंजी `401` लौटाती है।
विफलता मोड को `detail` स्ट्रिंग द्वारा पहचानें:
- `"Authentication credentials were not provided or are invalid."` —
कोई `x-api-key` हेडर नहीं (और कोई `Authorization: Bearer` token
नहीं), या प्रदान किया गया क्रेडेंशियल इंट्रोस्पेक्शन में विफल रहा
(निरस्त, समय-सीमा समाप्त, या विकृत)।
- `"You do not have permission to perform this action."` —
क्रेडेंशियल मान्य है लेकिन इस सत्र को नहीं पढ़ सकता है:
कंसोल-उपयोगकर्ता Bearer token में `read:sessions` अनुमति का अभाव है
या वह स्वामी एप्लिकेशन तक नहीं पहुंच सकता है, या API कुंजी सत्र से
भिन्न संगठन की है।
- `"You can only generate a PDF for sessions in review, declined,
approved or kyc expired"` — KYC सत्र मौजूद है लेकिन अभी तक किसी
पात्र स्थिति में नहीं है (उदाहरण के लिए `Not Started` या `In
Progress`)। रिपोर्ट का अनुरोध करने से पहले `status.updated` webhook
की प्रतीक्षा करें।
- `"You can only generate a PDF for sessions in review, declined or
approved"` — KYB सत्रों के लिए समान शर्त।
ध्यान दें कि पूरी तरह से अज्ञात `sessionId` के लिए endpoint
क्रेडेंशियल्स को मान्य करने से पहले स्वामी एप्लिकेशन की पहचान करता
है, इसलिए क्रेडेंशियल अनुपस्थित या अमान्य होने पर भी गायब सत्र `404`
लौटाता है।
content:
application/json:
schema:
type: object
properties:
detail:
type: string
example: >-
You can only generate a PDF for sessions in review,
declined, approved or kyc expired
examples:
Missing or invalid credentials:
summary: >-
कोई x-api-key हेडर नहीं है, या कुंजी इंट्रोस्पेक्शन में विफल
रही
value:
detail: >-
Authentication credentials were not provided or are
invalid.
Insufficient permissions:
summary: >-
मान्य क्रेडेंशियल जिसमें read:sessions या स्वामित्व वाले
एप्लिकेशन तक पहुंच का अभाव है
value:
detail: You do not have permission to perform this action.
KYC session not finished:
summary: KYC सत्र अभी भी शुरू नहीं हुआ / प्रगति पर है
value:
detail: >-
You can only generate a PDF for sessions in review,
declined, approved or kyc expired
KYB session not finished:
summary: KYB सत्र अभी भी शुरू नहीं हुआ / प्रगति पर है
value:
detail: >-
You can only generate a PDF for sessions in review,
declined or approved
'404':
description: >-
इस `sessionId` वाला कोई सक्रिय सत्र मौजूद नहीं है — यह कभी बनाया ही
नहीं गया था, या इसे हटा दिया गया है। क्रेडेंशियल सत्यापन से पहले ओनर
रिज़ॉल्यूशन होता है, इसलिए अप्रमाणित अनुरोधों के लिए भी यह `404`
लौटाया जाता है। कौन सा लुकअप मिस होता है, इसके आधार पर `detail`
स्ट्रिंग `"Not found."` (सामान्य मामला) या `"Session not found."`
होती है।
content:
application/json:
schema:
type: object
properties:
detail:
type: string
example: Not found.
examples:
Unknown session:
summary: sessionId किसी भी KYC या KYB सत्र से मेल नहीं खाता है
value:
detail: Not found.
Recently deleted session:
summary: लुकअप के बीच सत्र हटा दिया गया था
value:
detail: Session not found.
'429':
description: >-
रेट लिमिट पार हो गई। वैश्विक 600/मिनट GET सीमा के अतिरिक्त, PDF
जनरेशन की **प्रति क्रेडेंशियल 50 अनुरोध प्रति मिनट** (API कुंजी,
Bearer token, या अप्रमाणित होने पर स्रोत IP) की एक समर्पित सीमा है।
`Retry-After` सेकंड प्रतीक्षा करें (जो `X-RateLimit-*` हेडर में भी
दिखाई देता है), फिर पुनः प्रयास करें। रिपोर्ट सर्वर-साइड कैश नहीं की
जाती हैं, इसलिए प्रत्येक रिपोर्ट को एक बार डाउनलोड करें और इसे पुनः
प्राप्त करने के बजाय फ़ाइल को स्टोर करें।
headers:
Retry-After:
description: अनुरोध का पुनः प्रयास करने से पहले प्रतीक्षा करने के सेकंड।
schema:
type: integer
minimum: 1
example: 30
X-RateLimit-Limit:
description: वर्तमान विंडो में अनुमत PDF जनरेशन की अधिकतम संख्या (50)।
schema:
type: integer
example: 50
X-RateLimit-Remaining:
description: वर्तमान विंडो में शेष अनुरोध।
schema:
type: integer
example: 0
X-RateLimit-Reset:
description: Unix टाइमस्टैम्प (सेकंड) जिस पर वर्तमान विंडो रीसेट होती है।
schema:
type: integer
example: 1750000000
content:
application/json:
schema:
type: object
properties:
detail:
type: string
description: रेट लिमिट उल्लंघन का मानव-पठनीय स्पष्टीकरण।
example: >-
Session PDF generation rate limit exceeded. You can make
up to 50 requests per minute.
examples:
Throttled:
summary: समान क्रेडेंशियल से एक मिनट में 50 से अधिक PDF जनरेशन
value:
detail: >-
Session PDF generation rate limit exceeded. You can make
up to 50 requests per minute.
security:
- ApiKeyAuth: []
x-codeSamples:
- lang: curl
label: cURL
source: |-
curl --fail \
https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/generate-pdf/ \
-H 'x-api-key: YOUR_API_KEY' \
--output report.pdf
- lang: python
label: Python
source: |-
from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
content = client.sessions.generate_pdf(
"11111111-2222-3333-4444-555555555555",
)
with open("download.pdf", "wb") as file:
file.write(content)
- lang: javascript
label: Node.js
source: >-
import { writeFile } from "node:fs/promises";
import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const content = await
didit.sessions.generatePdf("11111111-2222-3333-4444-555555555555");
await writeFile("download.pdf", Buffer.from(await
content.arrayBuffer()));
- lang: go
label: Go
source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresp, err := client.Sessions.GeneratePDF(ctx, \"11111111-2222-3333-4444-555555555555\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer resp.Body.Close()\nfile, err := os.Create(\"download.pdf\")\nif err != nil {\n\tlog.Fatal(err)\n}\ndefer file.Close()\nif _, err := io.Copy(file, resp.Body); err != nil {\n\tlog.Fatal(err)\n}"
- lang: java
label: Java
source: >-
import java.nio.file.Path;
import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
client.sessions().generatePdf("11111111-2222-3333-4444-555555555555")
.writeTo(Path.of("download.pdf"));
- lang: php
label: PHP
source: >-
sessions->generatePdf('11111111-2222-3333-4444-555555555555');
$content->saveTo('download.pdf');
- lang: ruby
label: Ruby
source: >-
require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
content =
didit.sessions.generate_pdf("11111111-2222-3333-4444-555555555555")
File.binwrite("download.pdf", content)
- lang: csharp
label: .NET
source: >-
using System;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var content = await
client.Sessions.GeneratePdfAsync("11111111-2222-3333-4444-555555555555");
await content.SaveToAsync("download.pdf");
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: >-
आपकी एप्लिकेशन की 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।
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.