> ## 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（Fraud Check API）

> Diditの不正チェックAPIを使うと、本人確認、連絡先リスク、データエンリッチメント、ネットワークのチェックから必要なものを選び、1回のリクエストで計画・実行できます。

タイプ付き識別子と申告された本人属性を送信し、実行するチェックを選択して、各結果を個別に確認します。
まず[不正チェックを計画する](https://docs.didit.me/ja/standalone-apis/fraud-check-plan.md)で、入力要件と推定料金を確認してください。

## プロファイルを選択する

`profile_version`を固定して、選択されるデフォルト設定と判定ポリシーを明示します。
デフォルトのプロファイルは`standard`、バージョン`2026-08-27`です。
バージョン`2026-09-14`では、オプションのメールアドレスと電話番号のソーシャルエンリッチメントが追加され、完了したすべてのチェックがネイティブのユーザー認証セッションとして記録されます。
このバージョンでは、有料アドオンはオプトインです。
バージョン`2026-09-14.1`では、さらにグローバルに共有しているEnterpriseプランの組織に対して、グローバル不正ネットワークでの識別子照会が有効になります。
バージョン`2026-09-14.2`では、ブラジル向けにセルフィーとCPFを照合するオプションのリファレンスチェックが追加されます。
それ以前のバージョンは元の動作を維持します。

現在のプロファイルは、メールアドレスのリスク、電話番号のリスク、IPアドレスのリスク、対象となるデータベース検証、およびアプリケーションのプライベートネットワーク履歴に対応しています。
セルフィーによる本人紐付けには、バージョン`2026-09-14.2`が必要です。
それ以前のバージョンで選択すると、`not_available_in_profile_version`が返されます。

## 申告された本人情報とコンテキスト

メールアドレス、電話番号、政府発行の識別子は`subject.identifiers`に指定します。
政府発行の識別子には発行国が必要です。番号が地域内でのみ一意である場合は、発行機関も必要になることがあります。
氏名、生年月日、国籍、住所は`subject.attributes`に指定します。
これらは、選択したソースが対応している場合に照合される申告情報であり、送信されたからといって検証済みの事実になるわけではありません。

試行時のIPアドレス、ユーザーエージェント、目的、国、および必要な同意の表明には`context`を使用します。
これにより、検証の試行に関する情報と人物に関する情報が分離されます。
対応する生体チェックでは、`subject.selfie`をbase64エンコードされたJPEG、PNG、またはWebPで、最大6MBまで指定します。
同じ形式の画像データURIも受け付けます。
参照画像、リモートURL、ストレージキーは送信しないでください。

## セルフィーと申告された識別子

`biometric_identity`を選択し、ブラジルの`tax_number`識別子とセルフィーを送信して、`context.consent_obtained`を確認します。
リファレンス照会では、そのセルフィーが申告されたCPFの保有者のものかどうかを確認します。
同意がない場合は`consent_required`が、対応していない国の場合は`unsupported_region`が返されます。
このモジュールには、組織のデータベース検証の料金に基づくチェック1件あたりの料金がかかります。実行前にプランを確認してください。

リファレンスが応答すると、`identity_relationship.result`は`match`、`mismatch`、`inconclusive`のいずれかになります。
判定不能の応答はレビューが必要であり、不一致として扱われることはありません。
この結果が示すのは、セルフィーとCPFの関係のみです。
送信された氏名や生年月日の検証、ライブネスの証明、インターネットやグローバル不正ネットワーク全体での顔の検索は行いません。
選択した別のソースがこれらのフィールドの根拠を提供しない限り、氏名と生年月日は申告情報のままです。
タイムアウトとソースのエラーは利用不可の結果となり、課金されません。
完了した判定不能の結果にも、同じリファレンス照会料金が適用されます。
このチェックでは、セルフィーは結果に含まれず、セッションメディアとして保存されることもありません。

## チェックを選択する

`checks.include`でモジュールを選択し、`checks.exclude`が優先されます。
`include`に明示的に空のリストを指定すると、オプションの処理はすべて無効になります。正規化は引き続き実行されます。
`include`を省略すると、固定されたプロファイルのデフォルトが使用されます。
メールアドレスと電話番号のソーシャルエンリッチメントは、`email_social`と`phone_social`で個別に選択します。
これらには対応する有効な識別子が必要で、OTPは送信されません。

```json theme={null}
{
  "profile_version": "2026-09-14.1",
  "client_reference": "review-attempt-001",
  "subject": {
    "identifiers": [
      { "type": "email", "value": "applicant@example.com" }
    ],
    "attributes": { "first_name": "Alex", "last_name": "Example" }
  },
  "checks": { "include": ["networks_same_org", "networks_cross_org", "email_risk"] }
}
```

## 結果を混同せずに読み取る

各モジュールは、実行ステータス、理由、課金対象の単位数を報告します。
`not_requested`、`excluded_by_caller`、`missing_required_input`、`source_unavailable`は、それぞれ異なる結果を表します。
ソースがないことは、本人の不一致でもリスクゼロの結果でもありません。

`attribute_evidence`はフィールド単位の根拠を示し、`risk`は本人、連絡先、デバイス、行動、不正ネットワークの各観点を分けて保持します。
メールアドレス、デバイス、その他の識別子が共有されていることは観測された関連であり、2つのアカウントが同一人物のものである証拠や、不正を行った証拠ではありません。
`recommendation`はチェックによる推奨であり、他のレコードのステータスは変更しません。
ソーシャルエンリッチメントの結果は`enrichment`に表示され、利用不可の結果は完了した結果と区別されます。

## グローバル不正ネットワーク

`networks_cross_org`を選択すると、対応するメールアドレス、電話番号、および適切な名前空間が設定された書類識別子を共有ネットワークに照会します。
この照会には、Enterpriseプランと、組織の共有モードが`global`に設定されていることが必要です。
これらの条件を満たしていない場合、チェックの計画ではこのモジュールが`available: false`および`availability_reason: "entitlement_required"`として報告され、このモジュールを選択したチェックではステータス`skipped`、理由`entitlement_required`としてスキップされます。
組織でNetworksが有効になっていない場合も、同じ理由が適用されます。
サンドボックスのアプリケーションには、プランや共有モードによる制限はありません。対応する識別子があれば、モジュールが実行され、空のサンプル結果が返されます。
この照会は組織の既存の読み取り枠を使用し、その読み取りの監査記録を残します。
照会ごとの課金はありません。
チェックを計画するだけでは、共有インデックスへの照会も、その読み取り枠の消費も行われません。

チェックが完了すると、`network.cross_organization`には`signals_checked`と、開示された集計値である`insights`が含まれます。
各insightには、シグナルの種類、結果の分類、提供元の数、直近度の区分が含まれ、業種カテゴリは開示が有効な場合にのみ含まれます。
他の組織、アカウント、個人、または認証が特定されることは決してありません。
開示しきい値を下回る結果は省略されます。空のリストは、不正履歴が存在しないことを証明するものではありません。
開示された共有シグナルはレビューの推奨をトリガーしますが、自動的な却下や本人の一致判定になることは決してありません。

利用できなかった照会は、完了して結果が空だった照会とは区別して、その理由を報告します。
後に組織が組織横断アクセスを失った場合、たとえばプラン変更後や共有モードが`global`でなくなった場合には、結果の取得、再試行、セッション詳細において、共有集計値とそこから導出されたリスクの根拠が非表示になります。
元の推奨は過去の判定としてそのまま残り、読み取りによって認証ステータスが変わることはありません。

## セッション・再試行・課金

`check_id`を使うと、[Fraud Checkの取得](https://docs.didit.me/ja/standalone-apis/fraud-check-result.md)で保存済みの結果を取得できます。
`request_id`が存在する場合、そのチェックに対応するネイティブの認証セッションを示します。
バージョン`2026-09-14`、`2026-09-14.1`、`2026-09-14.2`では、プライベートネットワーク履歴のみを選択した場合も含め、常にそのセッションが作成されます。

そのチェックが存在する間は、同じリクエスト本文で`client_reference`を再利用すると、再実行も課金もなく元の結果が返されます。
同じ参照で異なる本文を送信すると、`409`が返されます。
実行がまだ進行中の場合は、レスポンスの`Retry-After`で指定された時間が経過してから、同じリクエストを再試行してください。
関連する認証を削除すると、Fraud Checkの結果も削除され、以降の取得では`404`が返されます。
実行中に削除されたチェックが、完了した結果を公開することはできません。

料金は、組織の現在の前払い料金または契約料金に基づきます。
利用できないモジュールとスキップされたモジュールは請求されず、プライベートネットワーク履歴にはチェックごとの課金はありません。
サンドボックスのチェックではサンプルレスポンスが使用され、有料のサプライヤーAPI呼び出しや課金は発生しません。


## OpenAPI

````yaml ja/openapi-25.json POST /v3/fraud/checks/
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/fraud/checks/:
    post:
      tags:
        - Fraud Check
      summary: 不正チェックを実行
      description: >-
        1つ以上の型付き識別子を送信すると、正規化、最新のエンリッチメント、国と識別子の種類が対象となる場合の権威あるソースによる検証、独立したリスク次元、推奨事項を1つのレスポンスで受け取れます。


        これらのプロファイルは識別子チェックに対応しています。セルフィーに基づく本人紐付け（`biometric_identity`）には、プロファイルバージョン`2026-09-14.2`とブラジルのCPFが必要です。ユーザーの同意があり、かつ組織にその利用資格がある場合にのみ実行されます。それ以前のバージョンでは`not_available_in_profile_version`として報告されます。実行できないモジュールは、決定論的な理由とともにスキップとして報告されます。応答できなかったソースが本人不一致として報告されることはありません。
      operationId: create_fraud_check
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/FraudCheckRequestRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/FraudCheckRequestRequest'
            example:
              client_reference: review-attempt-001
              subject:
                identifiers:
                  - type: email
                    value: applicant@example.com
                attributes:
                  first_name: Alex
                  last_name: Example
              checks:
                include:
                  - networks_same_org
                  - networks_cross_org
                  - email_risk
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FraudCheckRequestRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FraudCheckResponse'
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FraudClientCredentialsErrorMessage'
          description: ''
        '403':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/FraudClientCredentialsForbiddenErrorMessage
          description: ''
        '409':
          description: >-
            競合（課金なし）：`client_reference`が異なるリクエスト本文ですでに使用されている、同じ`client_reference`のチェックがまだ実行中である（同じリファレンスで`Retry-After`秒後に再試行してください）、またはこのチェックの記録先である認証がチェック完了前に削除された、のいずれかです。
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
              examples:
                different_body:
                  summary: 異なるボディで参照が再利用された
                  value:
                    error: >-
                      client_reference has already been used with a different
                      request body.
                still_running:
                  summary: この参照番号のチェックはまだ実行中です
                  value:
                    error: >-
                      A check with this client_reference is already running.
                      Retry with the same reference later.
                verification_deleted:
                  summary: チェックが完了する前に認証が削除されました
                  value:
                    error: This verification was deleted before the check completed.
          headers:
            Retry-After:
              description: 同じ`client_reference`のチェックがまだ実行中の場合に送信される、再試行までに待機する秒数。
              schema:
                type: integer
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
      x-codeSamples:
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.fraud_checks.create(
                client_reference="review-attempt-001",
                subject={
                    "identifiers": [{
                        "type": "email",
                        "value": "applicant@example.com",
                    }],
                    "attributes": {
                        "first_name": "Alex",
                        "last_name": "Example",
                    },
                },
                checks={
                    "include": ["networks_same_org", "networks_cross_org", "email_risk"],
                },
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            const result = await didit.fraudChecks.create({
              client_reference: "review-attempt-001",
              subject: {
                identifiers: [{
                  type: "email",
                  value: "applicant@example.com",
                }],
                attributes: {
                  first_name: "Alex",
                  last_name: "Example",
                },
              },
              checks: {
                include: ["networks_same_org", "networks_cross_org", "email_risk"],
              },
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.FraudChecks.Create(ctx, didit.FraudCheckRequestRequest{\n\tClientReference: didit.String(\"review-attempt-001\"),\n\tSubject: didit.FraudCheckSubjectRequest{\n\t\tIdentifiers: []didit.FraudCheckIdentifierRequest{{\n\t\t\tType:  didit.FraudTypeEnum(\"email\"),\n\t\t\tValue: \"applicant@example.com\",\n\t\t}},\n\t\tAttributes: didit.Some(didit.FraudCheckAttributesRequest{\n\t\t\tFirstName: didit.String(\"Alex\"),\n\t\t\tLastName:  didit.String(\"Example\"),\n\t\t}),\n\t},\n\tChecks: didit.Some(didit.FraudCheckModuleSelectionRequest{\n\t\tInclude: didit.Some([]didit.FraudExcludeEnum{didit.FraudExcludeEnum(\"networks_same_org\"), didit.FraudExcludeEnum(\"networks_cross_org\"), didit.FraudExcludeEnum(\"email_risk\")}),\n\t}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import java.util.List;

            import me.didit.Didit;

            import me.didit.types.FraudCheckAttributesRequest;

            import me.didit.types.FraudCheckIdentifierRequest;

            import me.didit.types.FraudCheckModuleSelectionRequest;

            import me.didit.types.FraudCheckRequestRequest;

            import me.didit.types.FraudCheckSubjectRequest;

            import me.didit.types.FraudExcludeEnum;

            import me.didit.types.FraudTypeEnum;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.fraudChecks().create(FraudCheckRequestRequest.builder()
                    .clientReference("review-attempt-001")
                    .subject(FraudCheckSubjectRequest.builder()
                            .identifiers(List.of(FraudCheckIdentifierRequest.builder()
                                    .type(FraudTypeEnum.of("email"))
                                    .value("applicant@example.com")
                                    .build()))
                            .attributes(FraudCheckAttributesRequest.builder()
                                    .firstName("Alex")
                                    .lastName("Example")
                                    .build())
                            .build())
                    .checks(FraudCheckModuleSelectionRequest.builder()
                            .include(List.of(FraudExcludeEnum.of("networks_same_org"), FraudExcludeEnum.of("networks_cross_org"), FraudExcludeEnum.of("email_risk")))
                            .build())
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->fraudChecks->create([
                'client_reference' => 'review-attempt-001',
                'subject' => [
                    'identifiers' => [[
                        'type' => 'email',
                        'value' => 'applicant@example.com',
                    ]],
                    'attributes' => [
                        'first_name' => 'Alex',
                        'last_name' => 'Example',
                    ],
                ],
                'checks' => [
                    'include' => ['networks_same_org', 'networks_cross_org', 'email_risk'],
                ],
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.fraud_checks.create(
              client_reference: "review-attempt-001",
              subject: {
                identifiers: [{
                  type: "email",
                  value: "applicant@example.com",
                }],
                attributes: {
                  first_name: "Alex",
                  last_name: "Example",
                },
              },
              checks: {
                include: ["networks_same_org", "networks_cross_org", "email_risk"],
              }
            )
            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await client.FraudChecks.CreateAsync(new
            FraudCheckRequestRequest

            {
                ClientReference = "review-attempt-001",
                Subject = new()
                {
                    Identifiers = new FraudCheckIdentifierRequest[]
                    {
                        new()
                        {
                            Type = "email",
                            Value = "applicant@example.com",
                        },
                    },
                    Attributes = new FraudCheckAttributesRequest
                    {
                        FirstName = "Alex",
                        LastName = "Example",
                    },
                },
                Checks = new FraudCheckModuleSelectionRequest
                {
                    Include = new FraudExcludeEnum[] { "networks_same_org", "networks_cross_org", "email_risk" },
                },
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    FraudCheckRequestRequest:
      type: object
      properties:
        client_reference:
          type: string
          minLength: 1
          description: >-
            このチェックに対するお客様独自の参照値です。冪等性キーを兼ねます。同じボディで再利用すると、モジュールを再実行・再請求することなく元のチェックが返されます。異なるボディで再利用すると409が返されます。
          maxLength: 255
        profile:
          type: string
          minLength: 1
          default: standard
          description: オーケストレーションプロファイルIDです。デフォルトはDiditの`standard`プロファイルです。
          maxLength: 64
        profile_version:
          type: string
          minLength: 1
          description: 固定されたプロファイルバージョンを指定します。デフォルトはプロファイルの現在のバージョンです。
          maxLength: 32
        subject:
          $ref: '#/components/schemas/FraudCheckSubjectRequest'
        context:
          $ref: '#/components/schemas/FraudCheckContextRequest'
        checks:
          $ref: '#/components/schemas/FraudCheckModuleSelectionRequest'
        vendor_data:
          type: string
          maxLength: 1000
        metadata: {}
      required:
        - subject
    FraudCheckResponse:
      type: object
      properties:
        check_id:
          type: string
          format: uuid
        request_id:
          type: string
          format: uuid
          description: このチェックのために作成されたネイティブの検証セッション。
        client_reference:
          type: string
          nullable: true
        processing_status:
          $ref: '#/components/schemas/FraudProcessingStatusEnum'
        profile_id:
          type: string
        profile_version:
          type: string
        created_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
          nullable: true
        inputs:
          type: array
          items:
            $ref: '#/components/schemas/FraudCheckInput'
        modules:
          type: array
          items:
            $ref: '#/components/schemas/FraudCheckModuleReport'
        attribute_evidence:
          type: array
          items:
            type: object
            additionalProperties: {}
        compound_evidence:
          type: array
          items:
            type: object
            additionalProperties: {}
        risk:
          type: array
          items:
            $ref: '#/components/schemas/FraudCheckRisk'
        network:
          type: object
          additionalProperties: {}
        enrichment:
          type: object
          additionalProperties: {}
        identity_relationship:
          allOf:
            - $ref: '#/components/schemas/FraudCheckIdentityRelationship'
          nullable: true
        recommendation:
          $ref: '#/components/schemas/FraudRecommendationEnum'
        next_action:
          $ref: '#/components/schemas/FraudNextActionEnum'
        decision_reasons:
          type: array
          items:
            type: string
        coverage:
          type: object
          additionalProperties: {}
        usage:
          type: array
          items:
            type: object
            additionalProperties: {}
        vendor_data:
          type: string
          nullable: true
        metadata:
          nullable: true
      required:
        - attribute_evidence
        - check_id
        - client_reference
        - completed_at
        - compound_evidence
        - coverage
        - created_at
        - decision_reasons
        - inputs
        - modules
        - network
        - next_action
        - processing_status
        - profile_id
        - profile_version
        - recommendation
        - risk
        - usage
    FraudClientCredentialsErrorMessage:
      type: object
      properties:
        detail:
          type: string
          default: 'Authentication failed: Invalid client access token.'
    FraudClientCredentialsForbiddenErrorMessage:
      type: object
      properties:
        detail:
          type: string
          default: Forbidden - User doesn't have permission
    FraudCheckSubjectRequest:
      type: object
      properties:
        selfie:
          type: string
          minLength: 1
          description: Base64エンコードされたJPEG、PNGまたはWebP形式のセルフィーで、最大6MBです。参照画像やURLは使用しません。
          maxLength: 8388672
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/FraudCheckIdentifierRequest'
          description: 1つ以上の型付き識別子です。1つで十分です。
          maxItems: 10
          minItems: 1
        attributes:
          $ref: '#/components/schemas/FraudCheckAttributesRequest'
      required:
        - identifiers
    FraudCheckContextRequest:
      type: object
      properties:
        ip_address:
          type: string
          minLength: 1
        user_agent:
          type: string
          maxLength: 512
        country:
          type: string
          description: 対象者が所在すると申告している国。参考情報にすぎず、本人であることの証明には決してなりません。
          maxLength: 3
        purpose:
          type: string
          maxLength: 128
        consent_obtained:
          type: boolean
    FraudCheckModuleSelectionRequest:
      type: object
      properties:
        include:
          type: array
          items:
            $ref: '#/components/schemas/FraudExcludeEnum'
        exclude:
          type: array
          items:
            $ref: '#/components/schemas/FraudExcludeEnum'
    FraudProcessingStatusEnum:
      enum:
        - pending
        - running
        - completed
        - failed
      type: string
      description: |-
        * `pending` - 保留中
        * `running` - 実行中
        * `completed` - 完了
        * `failed` - 失敗
    FraudCheckInput:
      type: object
      properties:
        reference:
          type: string
          description: 送信された識別子のマスク済みハンドル。
        type:
          $ref: '#/components/schemas/FraudTypeEnum'
        namespace:
          type: object
          additionalProperties: {}
        quality:
          type: string
        normalization:
          type: object
          additionalProperties: {}
        availability:
          $ref: '#/components/schemas/FraudAvailabilityEnum'
      required:
        - availability
        - namespace
        - normalization
        - quality
        - reference
        - type
    FraudCheckModuleReport:
      type: object
      properties:
        module:
          $ref: '#/components/schemas/FraudExcludeEnum'
        status:
          $ref: '#/components/schemas/FraudStatusEnum'
        reason:
          type: string
          nullable: true
        latency_ms:
          type: integer
        freshness:
          type: string
          nullable: true
        billable_units:
          type: integer
      required:
        - billable_units
        - freshness
        - latency_ms
        - module
        - reason
        - status
    FraudCheckRisk:
      type: object
      properties:
        dimension:
          $ref: '#/components/schemas/FraudDimensionEnum'
        score:
          type: integer
          nullable: true
        band:
          $ref: '#/components/schemas/FraudBandEnum'
        availability:
          $ref: '#/components/schemas/FraudAvailabilityEnum'
        requested_but_unavailable:
          type: boolean
          description: >-
            このディメンションに必要な情報がすべてリクエストで提供されたにもかかわらず、プラットフォームが回答できなかった場合はtrue。このようなチェックが、回答が得られた他のディメンションの結果を根拠に承認を推奨されることはありません。
        reason_codes:
          type: array
          items:
            type: string
        evidence_indexes:
          type: array
          items:
            type: integer
      required:
        - availability
        - band
        - dimension
        - evidence_indexes
        - reason_codes
        - requested_but_unavailable
        - score
    FraudCheckIdentityRelationship:
      type: object
      properties:
        result:
          $ref: '#/components/schemas/FraudResultEnum'
        reference_type:
          type: string
        country:
          type: string
        availability:
          $ref: '#/components/schemas/FraudAvailabilityEnum'
        reason_codes:
          type: array
          items:
            type: string
      required:
        - availability
        - country
        - reason_codes
        - reference_type
        - result
    FraudRecommendationEnum:
      enum:
        - approve
        - review
        - reject
      type: string
      description: |-
        * `approve` - 承認
        * `review` - レビュー
        * `reject` - 却下
    FraudNextActionEnum:
      enum:
        - none
        - manual_review
        - step_up
        - resubmit_capture
      type: string
      description: |-
        * `none` - なし
        * `manual_review` - 手動レビュー
        * `step_up` - ステップアップ
        * `resubmit_capture` - 撮影の再提出
    FraudCheckIdentifierRequest:
      type: object
      properties:
        type:
          allOf:
            - $ref: '#/components/schemas/FraudTypeEnum'
          description: |-
            識別子の種類。必須となるネームスペースのフィールドを決定します。

            * `email` - メールアドレス
            * `phone` - 電話番号
            * `national_id` - 国民ID
            * `tax_number` - 納税者番号
            * `passport_number` - パスポート番号
            * `driving_licence_number` - 運転免許証番号
            * `residence_permit_number` - 在留許可番号
            * `voter_id` - 有権者ID
            * `external_id` - 外部ID
        value:
          type: string
          minLength: 1
          description: 識別子の値です。一般的に使われる任意の形式で指定できます。
          maxLength: 255
        country:
          type: string
          description: >-
            ISO-3166
            alpha-2またはalpha-3形式の発行国。政府発行の識別子タイプでは必須です。同じ番号でも、国が異なれば別の人物を指すためです。
          maxLength: 3
        issuer:
          type: string
          description: 国だけでは一意に特定できない場合に指定する、任意の発行機関または国より下位の発行者です。
          maxLength: 128
      required:
        - type
        - value
    FraudCheckAttributesRequest:
      type: object
      description: 裏付けとなる属性。すべて任意で、指定するとモジュールの適用範囲が広がります。
      properties:
        first_name:
          type: string
          maxLength: 128
        last_name:
          type: string
          maxLength: 128
        full_name:
          type: string
          maxLength: 256
        date_of_birth:
          type: string
          format: date
        nationality:
          type: string
          maxLength: 3
        gender:
          type: string
          maxLength: 16
        address:
          type: string
          maxLength: 512
        city:
          type: string
          maxLength: 128
        state:
          type: string
          maxLength: 128
        postal_code:
          type: string
          maxLength: 32
    FraudExcludeEnum:
      enum:
        - normalization
        - email_risk
        - email_social
        - phone_social
        - phone_risk
        - ip_risk
        - database_validation
        - networks_same_org
        - networks_cross_org
        - biometric_identity
      type: string
      description: |-
        * `normalization` - 正規化
        * `email_risk` - メールアドレスのリスク
        * `email_social` - メールアドレスのソーシャル情報
        * `phone_social` - 電話番号のソーシャル情報
        * `phone_risk` - 電話番号のリスク
        * `ip_risk` - IPリスク
        * `database_validation` - データベース検証
        * `networks_same_org` - 同一組織内ネットワーク
        * `networks_cross_org` - 組織横断ネットワーク
        * `biometric_identity` - 生体情報による本人確認
    FraudTypeEnum:
      enum:
        - email
        - phone
        - national_id
        - tax_number
        - passport_number
        - driving_licence_number
        - residence_permit_number
        - voter_id
        - external_id
      type: string
      description: |-
        * `email` - メールアドレス
        * `phone` - 電話番号
        * `national_id` - 国民ID番号
        * `tax_number` - 納税者番号
        * `passport_number` - パスポート番号
        * `driving_licence_number` - 運転免許証番号
        * `residence_permit_number` - 在留許可番号
        * `voter_id` - 有権者ID
        * `external_id` - 外部ID
    FraudAvailabilityEnum:
      enum:
        - available
        - not_requested
        - no_reference
        - insufficient_history
        - unsupported_region
        - source_unavailable
      type: string
      description: |-
        * `available` - 利用可能
        * `not_requested` - 未リクエスト
        * `no_reference` - 参照データなし
        * `insufficient_history` - 履歴不足
        * `unsupported_region` - 非対応地域
        * `source_unavailable` - ソース利用不可
    FraudStatusEnum:
      enum:
        - planned
        - completed
        - skipped
        - failed
      type: string
      description: |-
        * `planned` - 予定
        * `completed` - 完了
        * `skipped` - スキップ
        * `failed` - 失敗
    FraudDimensionEnum:
      enum:
        - identity
        - contact
        - device_network
        - behavioral
        - fraud_network
      type: string
      description: |-
        * `identity` - 本人情報
        * `contact` - 連絡先
        * `device_network` - デバイス・ネットワーク
        * `behavioral` - 行動
        * `fraud_network` - 不正ネットワーク
    FraudBandEnum:
      enum:
        - low
        - medium
        - high
        - unknown
      type: string
      description: |-
        * `low` - 低
        * `medium` - 中
        * `high` - 高
        * `unknown` - 不明
    FraudResultEnum:
      enum:
        - match
        - mismatch
        - inconclusive
        - no_reference
      type: string
      description: |-
        * `match` - 一致
        * `mismatch` - 不一致
        * `inconclusive` - 判定不能
        * `no_reference` - 参照データなし
  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
    BearerAuth:
      type: http
      scheme: bearer
      description: アプリケーションのクライアントクレデンシャルのアクセストークン。

````

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