> ## 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 欺诈检测 API：在一次请求中规划并执行所选的身份、联系方式风险、信息补充和网络检测。

提交手动输入的标识符和声明的身份属性，选择要运行的检查，并分别查看每项结果。
请先通过 [规划欺诈检测](https://docs.didit.me/zh/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`。
这些内容是待比对的声明。只有所选数据源支持时才会进行比对，提交本身并不意味着它们已被验证为事实。

使用 `context` 提供验证尝试的地址、用户代理、用途、国家/地区，以及所需的同意声明。
这样可以将验证尝试本身的信息与当事人的信息区分开来。
对于支持的生物识别检查，请以 base64 编码的 JPEG、PNG 或 WebP 格式提供 `subject.selfie`，大小上限为 6 MB。
也接受对应的图像 data URI。
请勿发送参考图像、远程 URL 或存储密钥。

## 自拍照与声明的标识符

选择 `biometric_identity`，提交巴西 `tax_number` 标识符和自拍照，并确认 `context.consent_obtained`。
参照检查会判断该自拍照是否属于声明的 CPF 持有人。
缺少同意会返回 `consent_required`，不支持的国家/地区会返回 `unsupported_region`。
该模块按每次检查收费，价格基于您组织的数据库核验费率；运行前请先查看套餐。

参照检查返回结果后，`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` 将身份、联系方式、设备、行为和欺诈网络等维度分开呈现。
共享的邮箱、设备或其他标识符只是一种可观察到的关联，并不能证明两个账户属于同一个人，也不能证明存在欺诈行为。
`recommendation` 是该检查自身的建议，不会改变其他记录的状态。
社交信息补充的结果显示在 `enrichment` 下，其中不可用的结果与已完成的结果需加以区分。

## 全球欺诈网络

选择 `networks_cross_org`，即可在共享网络中查询受支持的邮箱、电话以及已正确添加命名空间的证件标识符。
该查询需要 Enterprise 套餐，并且您的组织的共享模式须设为 `global`。
如果不满足这两个条件，套餐会以 `available: false` 和 `availability_reason: "entitlement_required"` 报告该模块，选择了该模块的检查会被跳过，状态为 `skipped`，原因为 `entitlement_required`。
如果您的组织未启用网络功能，也会返回相同的原因。
沙盒应用不受套餐或共享模式限制：只要提供受支持的标识符，该模块就会运行并返回空的示例结果。
该查询使用组织现有的读取配额，并记录一条读取审计日志。
每次查询不单独收费。
规划检查本身不会查询共享索引，也不会消耗其读取配额。

检查完成后，`network.cross_organization` 包含 `signals_checked` 以及已披露的汇总 `insights`。
每条洞察包含信号类型、结果类别、贡献方数量、时间范围分组，以及仅在启用披露时才包含的行业类别。
它绝不会标识其他组织、账户、个人或验证。
低于披露阈值的结果会被省略；空列表并不能证明不存在欺诈历史。
一条已披露的共享信号只会触发审核建议，绝不会自动拒绝，也不构成身份匹配。

无法使用的查询会单独报告其原因，与已完成但结果为空的查询区分开来。
如果您的组织之后失去跨组织访问权限，例如套餐变更后，或共享模式不再为 `global`，则结果检索、重试和会话详情将隐藏共享汇总数据及由其推导出的风险证据。
原有建议仍作为历史决策保留；读取操作不会改变验证状态。

## 会话、重试与费用

`check_id` 通过[获取欺诈检查](https://docs.didit.me/zh/standalone-apis/fraud-check-result.md)检索已保存的结果。
存在 `request_id` 时，它标识其对应的原生验证会话。
版本 `2026-09-14`、`2026-09-14.1` 和 `2026-09-14.2` 始终会创建该会话，即使只选择了私有网络历史记录也是如此。

在检查仍然存在期间，使用相同请求正文复用 `client_reference`，将返回原始结果，不会再次执行或收费。
同一引用若搭配不同的请求正文，将返回 `409`。
如果检查仍在执行中，请在响应中 `Retry-After` 指定的间隔后重试同一请求。
删除关联的验证也会删除欺诈检查结果；此后检索将返回 `404`。
在执行过程中被删除的检查，不能发布已完成的结果。

价格取决于您组织当前的预付费或合同费率。
不可用和被跳过的模块不计费，私有网络历史记录也没有单次检查费用。
沙盒检查使用示例响应，不调用付费供应商，也不收费。


## OpenAPI

````yaml zh/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: >-
        提交一个或多个带类型的标识符，并在单个响应中接收标准化结果、最新补充数据、覆盖相应国家/地区和标识符类型的权威核验、独立风险维度以及建议。


        这些画像支持标识符核验。基于自拍照的身份绑定（`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 自拍照，最大 6 MB。无参考图片或 URL。
          maxLength: 8388672
        identifiers:
          type: array
          items:
            $ref: '#/components/schemas/FraudCheckIdentifierRequest'
          description: 一个或多个带类型的标识符。提供一个即可。
          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` - 身份证号
            * `tax_number` - 税号
            * `passport_number` - 护照号
            * `driving_licence_number` - 驾驶证号
            * `residence_permit_number` - 居留许可号
            * `voter_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` - 国民身份证号
        * `tax_number` - 税号
        * `passport_number` - 护照号码
        * `driving_licence_number` - 驾驶证号
        * `residence_permit_number` - 居留许可号码
        * `voter_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 的“开发者 -> API
        密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域：针对每个资源设为无权限、只读或读写，限定于特定工作流或已通过的会话、限定于
        IP 地址列表，以及设置到期日期。401 表示密钥错误、已撤销或已过期；403 表示未发送密钥、密钥无权访问该资源或操作，或请求来自其 IP
        列表之外的地址；在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF
        URL 将为 null；没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅
        https://docs.didit.me/console/api-keys。
    BearerAuth:
      type: http
      scheme: bearer
      description: 该应用的客户端凭证访问 token。

````

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