> ## 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.

# PDF生成API：KYC・KYBコンプライアンスレポート

> DiditのGET /v3/session/{id}/generate-pdf/で、KYCまたはKYBセッションのブランド入りコンプライアンスレポートをダウンロードできます。ホワイトラベル対応、監査に対応、従量課金制。



PDF生成プロンプト
        プロンプトをクリップボードにコピー



      
      

\<pre>

\`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/<SESSION_ID>/generate-pdf/ \
-H "x-api-key: <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_<session_id>.pdf for KYC sessions, business_<session_id>.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.`

\</pre>



      
      

貼り付け先

## KYCとKYBのサポート**本人確認（KYC）**と**法人確認 (KYB)**の両方のセッションで利用できます。Diditが適切なPDFテンプレートを自動的に選択します。- 本人確認（KYC）セッション → 本人確認、ライブネス検知、顔照合、AMLスクリーニング、住所証明の各セクションを含むレポート。
- 法人確認 (KYB)セッション → 法人登記、主要人物（UBO/役員）、書類、AMLスクリーニング、アンケート、電話番号、メールアドレス、IP分析の各セクションを含むレポート（それらの機能がワークフローに含まれている場合）。どちらも同じPDF生成パイプラインを使用し、ホワイトラベルのカスタマイズ（ロゴ、プライバシーポリシーのURL）に対応しています。## ファイル名の規則| 種類 | ファイル名 |
| - | - |
| ユーザー | `session_<session_id>.pdf` |
| 企業 | `business_<session_id>.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/ja/sessions-api/overview.md)
- [セッションの取得](https://docs.didit.me/ja/sessions-api/retrieve-session.md)：同じ判定のJSON版
- [ユーザー履歴PDFのダウンロード](https://docs.didit.me/ja/management-api/users/generate-pdf.md)：1人のユーザーのレポート対象となるすべてのセッションを1つのファイルにまとめたもの
- [KYBレスポンススキーマ](https://docs.didit.me/ja/business-verification/response-schema.md)：企業向けPDFに含まれるフィールド


## OpenAPI

````yaml ja/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が再レンダリングされるため、手動レビュー後に生成したレポートにはレビュアーの判定が反映されます。同じセッションに対する2回の呼び出しで、バイト単位で異なるファイルが生成されることがあります。変更されないコピーが必要な場合は、ダウンロードしたファイルを保管してください。


        **レイテンシ。** レンダリングでは、PDFを構成する前に保存されているすべての画像 (書類の各面、セルフィー、追加ファイル)
        をダウンロードするため、メディアの多いセッションでは数秒かかることがあります。クライアントの読み取りタイムアウトには十分な値 (60秒を推奨)
        を設定し、本文をディスクにストリーミングしてください。


        **末尾のスラッシュ。** 正規のルートは末尾がスラッシュで終わります
        (`…/generate-pdf/`)。スラッシュのないリクエストも同じレスポンスで直接処理されます。`301`リダイレクトは発生しないため、クライアントがリダイレクトを追跡する必要はなく、`curl`に`-L`も不要です。サンプルと同様に、スラッシュ付きのURLを使用してください。


        レンダリングされたレポートではなく基になるデータをJSONで取得する場合は、`GET
        /v3/session/{sessionId}/decision/`を使用してください。1人のユーザーのレポート対象となるすべてのセッションを1つのドキュメントにまとめるには、`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コンバーターは正規の小文字形式にのみ一致するため、16進数が大文字の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`トークンもない）、または指定された認証情報がイントロスペクションに失敗した（失効、期限切れ、または形式不正）。

            - `"You do not have permission to perform this
            action."`：認証情報は有効だが、このセッションを読み取れない。コンソールユーザーのBearerトークンに`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`の場合、このエンドポイントは認証情報を検証する前に所有アプリケーションを解決するため、認証情報がないか無効であっても、存在しないセッションには`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セッションがまだNot Started / In Progressの状態です
                  value:
                    detail: >-
                      You can only generate a PDF for sessions in review,
                      declined, approved or kyc expired
                KYB session not finished:
                  summary: KYBセッションがまだNot Started / In Progressの状態です
                  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: >-
            レート制限を超過しました。PDF生成には、GET全体に適用される1分あたり600件の制限に加えて、**認証情報ごとに1分あたり50件**（APIキー、Bearerトークン、または未認証の場合は送信元IP）という専用の制限があります。`Retry-After`秒（`X-RateLimit-*`ヘッダーにも反映されます）待ってから再試行してください。レポートはサーバー側でキャッシュされないため、各レポートは1回だけダウンロードしてファイルを保存し、再取得しないでください。
          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: 同じ認証情報から1分間に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: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY.

            $didit = new DiditClient();


            $content =
            $didit->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で取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権（なし、読み取り、書き込み）、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください:
        https://docs.didit.me/console/api-keys

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.