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

# ケース更新API

> Didit Management APIでケースのタイトル、優先度、期日、タグ、担当レビューチームを変更できます。送信したフィールドのみが更新され、主な変更はケースのタイムラインに記録されます。



ケース更新APIのプロンプト
        プロンプトをクリップボードにコピー



      
      

\<pre>

\`Update a case's title, priority, due date, tags or owning review team through the Management API.

Endpoint:
PATCH https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/

Authentication:
Use the x-api-key header with my Didit API key.
Cases endpoints need a full-access API key: a key with restricted access gets 403.

Request body (partial: send only the fields to change, omitted fields keep their value):
\{"priority": "HIGH", "due_at": "2026-11-01T00:00:00Z", "team": "<review-team-uuid>"}
\- title - string, at most 255 characters.
\- priority - LOW | MEDIUM | HIGH.
\- due_at - ISO 8601 datetime, or null to clear the deadline.
\- tags - array of strings. Replaces the whole tag list, so send every tag the case should keep.
\- team - uuid of an active review team of this application, or null to clear the team.

Getting a team uuid:
GET https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/teams/ (same full-access key; a console member token needs list:cases) returns results[] with uuid, name and is_active. Only a team with is_active true is accepted.

Behavior:
\- Logs PRIORITY_CHANGED, DUE_DATE_CHANGED, TAG_ADDED, TAG_REMOVED and TEAM_CHANGED events on the case when the value changes.
\- A title change is saved without a timeline event.
\- A TEAM_CHANGED event records the previous and new team as {uuid, name} in its metadata.
\- Changing the team does not reassign the case.

Example call:
curl -X PATCH "https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"team": "<review-team-uuid>"}'

Response 200: the updated CaseDetail, the same shape as get case, including team {uuid, name} or null.

Failure modes:
\- 400: a field failed validation, keyed by field. Example: {"team": ["Choose an active team of this application."]} when the team is inactive, deleted, or belongs to another application.
\- 401/403: auth/permission errors. A key with restricted access gets 403 {"detail": "This API key has no access to this endpoint."} (cases need a full-access key). A console member token needs write:cases.
\- 404: case not found in this application.

For the full integration shape, see /integration/integration-prompt.`

\</pre>



      
      

貼り付け先

ケースのタイトル、優先度、期日、タグ、担当レビューチームを変更します。
変更したいフィールドだけを送信してください。省略したフィールドは現在の値が維持されます。
`tags`はタグリスト全体を置き換えるため、ケースに残すすべてのタグを送信してください。## 担当チームを変更する`team`にこのアプリケーションの有効なレビューチームのuuidを設定するか、`null`を設定してチームの設定を解除します。
チームのuuidを確認するには、`GET /v3/organization/{organization_id}/application/{application_id}/cases/teams/`を呼び出して`results[].uuid`を参照してください。
無効化されたチーム、削除されたチーム、または別のアプリケーションに属するチームを指定すると、`{"team": ["Choose an active team of this application."]}`とともに`400`が返されます。
変更のたびに、変更前と変更後のチームを含む`TEAM_CHANGED`イベントがケースのタイムラインに追加されます。
チームを変更しても、ケースの担当者は変わりません。## タイムラインイベント優先度、期日、タグ、チームを変更すると、`PRIORITY_CHANGED`、`DUE_DATE_CHANGED`、`TAG_ADDED`、`TAG_REMOVED`、`TEAM_CHANGED`のいずれかのイベントがケースのタイムラインに追加されます。
タイトルの変更は、タイムラインイベントなしで保存されます。
フィールドを現在と同じ値で送信した場合、イベントは追加されません。## アクセスケースのエンドポイントには、フルアクセスの[APIキー](https://docs.didit.me/ja/console/api-keys.md)が必要です。
アクセスが制限されたキーには`403`が返されます。
コンソールのメンバーのトークンには`write:cases`が必要です。## 関連情報- [ケースを取得する](https://docs.didit.me/ja/management-api/cases/get.md)
- [ケースを一覧表示する](https://docs.didit.me/ja/management-api/cases/list.md)
- [割り当てとレビューチーム(コンソール)](https://docs.didit.me/ja/console/case-management/assignment.md#チーム)


## OpenAPI

````yaml ja/openapi-25.json PATCH /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/
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/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/:
    patch:
      tags:
        - Cases
      summary: ケースを更新
      description: >-
        ケースのタイトル、優先度、期日、タグ、または担当レビューチームを更新します。変更したいフィールドのみを送信してください。省略したフィールドは現在の値が維持されます。`tags`はタグリスト全体を置き換えます。`team`には、このアプリケーションの有効なレビューチームのuuid(`GET
        .../cases/teams/`で一覧を取得できます)を指定するか、チームを解除する場合はnullを指定します。フルアクセスのAPIキー、またはコンソールメンバーの場合は`write:cases`が必要です。アクセスが制限されたキーでは403が返されます。該当する場合はPRIORITY_CHANGED、DUE_DATE_CHANGED、TAG_ADDED、TAG_REMOVED、TEAM_CHANGEDイベントが記録されます。タイトルの変更はタイムラインイベントなしで保存されます。更新後のケースを返します。
      operationId: update_case
      parameters:
        - name: organization_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: 組織のUUIDです。
        - name: application_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: アプリケーションのUUID。
        - name: case_uuid
          in: path
          required: true
          schema:
            type: string
            format: uuid
            example: c1a5e000-0000-4000-8000-000000000001
          description: ケースのUUID。
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  maxLength: 255
                  description: 新しいケースのタイトル。
                priority:
                  type: string
                  enum:
                    - LOW
                    - MEDIUM
                    - HIGH
                due_at:
                  type: string
                  format: date-time
                  nullable: true
                  description: 新しい期限。クリアするにはnullを送信します。
                tags:
                  type: array
                  items:
                    type: string
                  description: 完全なタグリスト。現在のタグを置き換えます。
                team:
                  type: string
                  format: uuid
                  nullable: true
                  description: >-
                    ケースを担当するレビューチームのUUID。このアプリケーションの有効なチームである必要があります。チームの割り当てを解除するにはnullを送信します。
            examples:
              Change priority and deadline:
                value:
                  priority: HIGH
                  due_at: '2026-11-01T00:00:00Z'
              Move the case to a team:
                value:
                  team: 3fa85f64-5717-4562-b3fc-2c963f66afa6
              Clear the team:
                value:
                  team: null
      responses:
        '200':
          description: 更新後のケース。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaseDetail'
        '400':
          description: >-
            フィールドの検証に失敗しました。本文はフィールド名をキーとしています。`team`は、このアプリケーションの有効なレビューチームでない場合に拒否されます。
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    type: string
              examples:
                Team not active in this application:
                  value:
                    team:
                      - Choose an active team of this application.
                Invalid priority:
                  value:
                    priority:
                      - '"URGENT" is not a valid choice.'
        '403':
          description: >-
            APIキーが別のアプリケーションに属しているか、アクセスが制限されたキーです。ケースのエンドポイントにはフルアクセスキーが必要です。コンソールメンバーのトークンには`write:cases`が必要です。
          content:
            application/json:
              examples:
                Restricted API Key:
                  summary: アクセスが制限されたAPIキー
                  value:
                    detail: This API key has no access to this endpoint.
                Missing Privilege:
                  summary: write:casesを持たないコンソールメンバー、または別のアプリケーションのキー
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: このアプリケーションにケースが見つかりません。
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: No Case matches the given query.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X PATCH
            'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/'
            \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"priority": "HIGH", "due_at": "2026-08-01T00:00:00Z"}'
        - lang: curl
          label: curl (change team)
          source: >-
            curl -X PATCH
            'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/cases/c1a5e000-0000-4000-8000-000000000001/'
            \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"team": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
            # and DIDIT_APPLICATION_ID.
            client = Didit()

            result = client.cases.update(
                "c1a5e000-0000-4000-8000-000000000001",
                priority="HIGH",
                due_at="2026-11-01T00:00:00Z",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID

            // and DIDIT_APPLICATION_ID.

            const didit = new Didit();


            const result = await
            didit.cases.update("c1a5e000-0000-4000-8000-000000000001", {
              priority: "HIGH",
              due_at: "2026-11-01T00:00:00Z",
            });

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Cases.Update(ctx, \"c1a5e000-0000-4000-8000-000000000001\", didit.CasesUpdateParams{\n\tPriority: didit.Some(didit.CasesUpdateParamsPriority(\"HIGH\")),\n\tDueAt:    didit.Time(time.Date(2026, 11, 1, 0, 0, 0, 0, time.UTC)),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import java.time.OffsetDateTime;

            import me.didit.Didit;

            import me.didit.types.CasesUpdateParams;


            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID

            // and DIDIT_APPLICATION_ID.

            Didit client = new Didit();


            var result =
            client.cases().update("c1a5e000-0000-4000-8000-000000000001",
            CasesUpdateParams.builder()
                    .priority(CasesUpdateParams.Priority.of("HIGH"))
                    .dueAt(OffsetDateTime.parse("2026-11-01T00:00:00Z"))
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: >-
            <?php


            require 'vendor/autoload.php';


            use Didit\DiditClient;


            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID

            // and DIDIT_APPLICATION_ID.

            $didit = new DiditClient();


            $result =
            $didit->cases->update('c1a5e000-0000-4000-8000-000000000001', [
                'priority' => 'HIGH',
                'due_at' => '2026-11-01T00:00:00Z',
            ]);

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID
            # and DIDIT_APPLICATION_ID.
            didit = Didit::Client.new

            result = didit.cases.update(
              "c1a5e000-0000-4000-8000-000000000001",
              priority: "HIGH",
              due_at: "2026-11-01T00:00:00Z"
            )
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID

            // and DIDIT_APPLICATION_ID.

            using var client = new DiditClient();


            var result = await
            client.Cases.UpdateAsync("c1a5e000-0000-4000-8000-000000000001", new
            CasesUpdateParams

            {
                Priority = new CasesUpdateParamsPriority("HIGH"),
                DueAt = DateTimeOffset.Parse("2026-11-01T00:00:00Z"),
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    CaseDetail:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        case_number:
          type: string
          nullable: true
        title:
          type: string
        status:
          type: string
          enum:
            - OPEN
            - AWAITING_USER
            - RESOLVED
        resolution:
          type: string
          enum:
            - FALSE_POSITIVE
            - VALID_THREAT
            - INCONCLUSIVE
            - REQUIREMENTS_NOT_MET
            - REQUIREMENTS_SATISFIED
          nullable: true
        resolution_notes:
          type: string
          nullable: true
        priority:
          type: string
          enum:
            - LOW
            - MEDIUM
            - HIGH
        source:
          type: string
          enum:
            - MANUAL
            - AML_SCREENING
            - TRANSACTION_RULE
            - WORKFLOW_BUILDER
        tags:
          type: array
          items:
            type: string
        subject:
          $ref: '#/components/schemas/CaseSubject'
        assigned_to:
          $ref: '#/components/schemas/CaseAssignee'
        assigned_at:
          type: string
          format: date-time
          nullable: true
        team:
          $ref: '#/components/schemas/CaseTeamSummary'
        due_at:
          type: string
          format: date-time
          nullable: true
        resolved_at:
          type: string
          format: date-time
          nullable: true
        resolved_by_email:
          type: string
          nullable: true
        pending_resolution:
          type: object
          nullable: true
          description: 4眼原則による解決がチェッカーのブループリント上で保留され、承認または承認の却下を待っている間のみ設定されます。
          properties:
            resolution:
              type: string
              enum:
                - FALSE_POSITIVE
                - VALID_THREAT
                - INCONCLUSIVE
                - REQUIREMENTS_NOT_MET
                - REQUIREMENTS_SATISFIED
            resolution_notes:
              type: string
              nullable: true
            maker_email:
              type: string
              format: email
              nullable: true
              description: >-
                解決内容を提出した担当者のメールアドレス。APIキーで提出された場合はnullです。その解決内容には作成者が記録されないため、approveおよびreject-approvalはすべての呼び出し元に対して403を返します。
            maker_name:
              type: string
              nullable: true
            maker_user_id:
              type: string
              format: uuid
              nullable: true
              description: >-
                解決を送信した担当者のメンバーユーザーUUIDです。APIキーで送信された場合はnullです。そのメンバーを`checker`として指定することはできません。
            maker_blueprint_id:
              type: string
              format: uuid
            staged_at:
              type: string
              format: date-time
        checker:
          $ref: '#/components/schemas/CaseChecker'
        metadata:
          type: object
        blueprint:
          $ref: '#/components/schemas/CaseBlueprintDetail'
        notes:
          type: array
          items:
            $ref: '#/components/schemas/CaseNote'
          description: 最新の50件のメモ。
        events:
          type: array
          items:
            $ref: '#/components/schemas/CaseEvent'
          description: 最新の100件のイベント。
        links:
          type: array
          items:
            $ref: '#/components/schemas/CaseLink'
        links_count:
          type: integer
        notes_count:
          type: integer
        checklist_items:
          type: array
          items:
            $ref: '#/components/schemas/CaseChecklistItem'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    CaseSubject:
      type: object
      nullable: true
      description: ケースが紐づく単一のユーザーまたは企業。
      properties:
        type:
          type: string
          enum:
            - user
            - business
        uuid:
          type: string
          format: uuid
        name:
          type: string
        external_id:
          type: string
          nullable: true
          description: 対象のvendor_data。
        country:
          type: string
          nullable: true
          description: >-
            対象者の3文字の国コード(ISO 3166-1
            alpha-3)。不明な場合はnullです。企業の場合は設立国です。個人の場合は、認証で提出された本人確認書類の発行国です。複数の国の書類を持つ個人の場合はそのうち1つが表示され、`XXA`などのICAO書類コードが表示されることもあります。
          example: ESP
        portrait:
          type: string
          format: uri
          nullable: true
          description: >-
            人物の顔写真画像への有効期間の短い署名付きURL。企業の場合は常にnullで、顔写真のない人物の場合もnullです。URLには有効期限があるため、URLを保存するのではなく、ケースを読み取る際に画像をダウンロードしてください。
    CaseAssignee:
      type: object
      nullable: true
      properties:
        uuid:
          type: string
          format: uuid
        full_name:
          type: string
        email:
          type: string
          format: email
    CaseTeamSummary:
      type: object
      nullable: true
      description: >-
        ケースを担当するレビューチームです。担当チームがない場合はnullです。ルーティングルールによってケースがいずれかのチームに割り当てられると、ルーティングにより設定されます。`PATCH
        .../cases/{case_uuid}/`（`team`）で変更またはクリアできます。
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
    CaseChecker:
      type: object
      nullable: true
      description: >-
        保留中の解決を承認または却下するよう指名されたメンバーです。二者承認(four-eyes)方式の解決が指名されたチェッカーを待っている間のみ設定されます。保留中のものがない場合、保留中の解決がチェッカーキューで待機している間、および解決が承認、却下された後や、証拠が変更されたために新たなレビューに差し戻された後はnullです。
      properties:
        member_uuid:
          type: string
          format: uuid
          description: メンバーのユーザーuuidです。ケースを解決する際に`checker`として渡す値です。
        name:
          type: string
          nullable: true
          description: メンバーの氏名です。不明な場合はnullです。
        email:
          type: string
          format: email
    CaseBlueprintDetail:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
          maxLength: 24
        description:
          type: string
          nullable: true
        assignment_method:
          type: string
          enum:
            - MANUAL
            - AUTOMATIC
        assignee_pool:
          type: array
          items:
            type: string
            format: uuid
        max_active_cases:
          type: integer
          nullable: true
        escalation_enabled:
          type: boolean
        transfer_enabled:
          type: boolean
        require_resolution_note:
          type: boolean
        is_active:
          type: boolean
        preset_key:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        escalation_blueprint:
          type: string
          format: uuid
          nullable: true
        escalation_blueprint_name:
          type: string
          nullable: true
        four_eyes_checker_blueprint:
          type: string
          format: uuid
          nullable: true
        four_eyes_checker_blueprint_name:
          type: string
          nullable: true
        content_config:
          type: object
          description: ケースページに表示されるタブとフィールドを決定する、切り替え可能な6つのセクション。不明なセクションやキーは拒否されます。
          properties:
            checklist:
              type: object
              properties:
                enabled:
                  type: boolean
                optional:
                  type: boolean
                  description: trueの場合、チェックリストに未完了の項目があってもケースを解決できます。
                items:
                  type: array
                  items:
                    type: object
                    properties:
                      label:
                        type: string
                        maxLength: 255
                      order:
                        type: integer
            aml_control:
              type: object
              properties:
                enabled:
                  type: boolean
                financial:
                  type: boolean
                identity:
                  type: boolean
            identity:
              type: object
              properties:
                enabled:
                  type: boolean
                personal_information:
                  type: boolean
                applicant_tags:
                  type: boolean
                contact_information:
                  type: boolean
                risk_overview:
                  type: boolean
                poi_documents:
                  type: boolean
                poa_documents:
                  type: boolean
            verifications:
              type: object
              properties:
                enabled:
                  type: boolean
                summary:
                  type: boolean
            reporting:
              type: object
              properties:
                enabled:
                  type: boolean
                fiu_reports:
                  type: boolean
            financial:
              type: object
              properties:
                enabled:
                  type: boolean
                payment_methods:
                  type: boolean
                transactions:
                  type: boolean
        creation_sources:
          type: array
          description: 現在、新しいケースをこのブループリントに振り分けているコネクター。
          items:
            type: object
            properties:
              kind:
                type: string
                enum:
                  - aml
                  - rule
                  - workflow
              id:
                type: string
              name:
                type: string
        receives_escalation_from:
          type: array
          description: エスカレーション先としてこのブループリントを指定している他のブループリントです。
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
        updated_at:
          type: string
          format: date-time
        version:
          type: integer
          readOnly: true
        default_deadline_hours:
          type: integer
          nullable: true
          minimum: 1
          maximum: 8760
    CaseNote:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        comment:
          type: string
        actor_email:
          type: string
          format: email
          nullable: true
        actor_name:
          type: string
          nullable: true
        mentioned_emails:
          type: array
          items:
            type: string
            format: email
        is_internal:
          type: boolean
        attachments:
          type: array
          items:
            type: object
            properties:
              s3_key:
                type: string
              filename:
                type: string
              file_size:
                type: integer
              url:
                type: string
                format: uri
        tags:
          type: array
          items:
            type: string
        created_at:
          type: string
          format: date-time
    CaseEvent:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        event_type:
          type: string
          enum:
            - CREATED
            - STATUS_CHANGED
            - ASSIGNED
            - UNASSIGNED
            - RESOLVED
            - REOPENED
            - LINK_ADDED
            - LINK_REMOVED
            - NOTE_ADDED
            - NOTE_PINNED
            - NOTE_UNPINNED
            - PRIORITY_CHANGED
            - DUE_DATE_CHANGED
            - TAG_ADDED
            - TAG_REMOVED
            - ESCALATED
            - TRANSFERRED
            - CHECKLIST_COMPLETED
            - REPORT_CREATED
            - REPORT_FINALIZED
            - SUBMITTED_FOR_APPROVAL
            - APPROVAL_GRANTED
            - APPROVAL_REJECTED
            - ENTITY_ACTION
            - APPROVAL_INVALIDATED
            - CUSTOMER_REQUEST
            - STAGE_CHANGED
            - TEAM_CHANGED
            - CHECKER_ASSIGNED
            - CHECKER_UNASSIGNED
        actor_email:
          type: string
          format: email
          nullable: true
        actor_name:
          type: string
          nullable: true
        previous_status:
          type: string
          enum:
            - OPEN
            - AWAITING_USER
            - RESOLVED
          nullable: true
        new_status:
          type: string
          enum:
            - OPEN
            - AWAITING_USER
            - RESOLVED
          nullable: true
        metadata:
          type: object
        created_at:
          type: string
          format: date-time
    CaseLink:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        linked_entity_type:
          type: string
          enum:
            - session
            - business_session
            - transaction
          nullable: true
        linked_entity_uuid:
          type: string
          format: uuid
          nullable: true
        linked_entity_summary:
          type: object
          nullable: true
          description: >-
            sessionおよびbusiness_sessionのリンクではsession_id/session_number/status、transactionのリンクではuuid/txn_id/statusです。
        created_at:
          type: string
          format: date-time
    CaseChecklistItem:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        label:
          type: string
          maxLength: 255
        is_completed:
          type: boolean
        completed_by:
          type: string
          format: email
          nullable: true
        completed_at:
          type: string
          format: date-time
          nullable: true
        order:
          type: integer
  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.