> ## 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 提供 GET /v3/biometric-templates/count/ 接口，可按列表接口相同的过滤条件，统计应用保留的无图像人脸生物特征模板数量。

返回与 [列出生物特征模板](https://docs.didit.me/zh/management-api/biometric-templates/list.md) 所用过滤条件相同的模板数量。已清除的模板不计入在内。

```bash theme={null}
curl -X GET "https://verification.didit.me/v3/biometric-templates/count/?status=active" \
  -H "x-api-key: YOUR_API_KEY"
```

```json theme={null}
{ "count": 128 }
```

可用于在仪表板上显示总数，也可在运行带有 `delete_all: true` 的经过筛选的[批量清除](https://docs.didit.me/zh/management-api/biometric-templates/batch-purge.md)之前，检查它将影响哪些模板。


## OpenAPI

````yaml zh/openapi-25.json GET /v3/biometric-templates/count/
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/biometric-templates/count/:
    get:
      tags:
        - Biometric Templates
      summary: 统计保留的生物特征模板数量
      description: >-
        选择启用的应用在会话被删除时（参见 `DELETE
        /v3/session/{sessionId}/delete/`），会保留一个锚定到用户的、独立管理的无图像人脸生物特征模板。模板是具有有限
        `expires_at` 的生物识别数据；它们绝不包含图像、会话数据或身份字段，并在用户删除、隐私清除、过期或明确清除时被清除。这些
        endpoint 仅接受应用 API 密钥（`x-api-key`）；Business Console 用户 token 将被拒绝并返回
        `403`。


        返回使用与列表 endpoint 相同过滤器匹配的模板数量。用于检查带有 `delete_all: true` 的过滤批量清除将影响哪些模板。
      operationId: count_biometric_templates
      parameters:
        - in: query
          name: vendor_data
          required: false
          description: 对所属用户的当前 `vendor_data` 进行不区分大小写的子字符串匹配。
          schema:
            type: string
        - in: query
          name: vendor_user_uuid
          required: false
          description: 对所属用户的精确匹配。
          schema:
            type: string
            format: uuid
        - in: query
          name: status
          required: false
          description: 生命周期状态。已清除的模板绝不会被列出。
          schema:
            type: string
            enum:
              - pending
              - active
              - expired
              - held_out_of_use
              - purge_pending
              - purge_failed
        - in: query
          name: source_type
          required: false
          description: 模板的创建方式。
          schema:
            type: string
            enum:
              - session_delete
              - automatic_retention
              - backfill
        - in: query
          name: retained_from
          required: false
          description: 在此时间或之后保留的模板。
          schema:
            type: string
            format: date-time
        - in: query
          name: retained_to
          required: false
          description: 在此时间或之前保留的模板。不得早于 `retained_from`（`400`）。
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: 计数。
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                    minimum: 0
              examples:
                Count:
                  value:
                    count: 128
        '400':
          description: 无效的过滤值，或 `retained_to` 早于 `retained_from`。按字段索引的验证错误。
          content:
            application/json:
              examples:
                Bad range:
                  value:
                    retained_to:
                      - Must be on or after retained_from.
        '403':
          description: Console 用户 token，或该 API 密钥不被允许。这些 endpoint 仅接受应用 API 密钥。
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/biometric-templates/count/?status=active'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.biometric_templates.count()
            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.biometricTemplates.count();
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.BiometricTemplates.Count(ctx, didit.BiometricTemplatesCountParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            var result = client.biometricTemplates().count();
            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->biometricTemplates->count();
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.biometric_templates.count
            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.BiometricTemplates.CountAsync();
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  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。

````

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