> ## 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. # List Biometric Templates > GET /v3/biometric-templates/ — paginated list of the image-free face biometric templates your application retains, filtered by user, status, source, and date. Returns a paginated list of the biometric templates your application currently holds. Purged templates are not listed. ## Query parameters | Parameter | Type | Description | | ------------------ | -------- | ------------------------------------------------------------------------------------ | | `vendor_data` | string | Case-insensitive substring match on the owning User's current `vendor_data` | | `vendor_user_uuid` | UUID | Exact match on the owning User | | `status` | enum | `pending`, `active`, `expired`, `held_out_of_use`, `purge_pending`, `purge_failed` | | `source_type` | enum | `session_delete`, `automatic_retention`, `backfill` | | `retained_from` | datetime | Templates retained at or after this time | | `retained_to` | datetime | Templates retained at or before this time. Must not be earlier than `retained_from`. | | `ordering` | enum | `retained_at`, `-retained_at` (default), `expires_at`, `-expires_at` | | `limit` | integer | Page size | | `offset` | integer | Pagination offset | ## Example ```bash theme={null} curl -X GET "https://verification.didit.me/v3/biometric-templates/?vendor_data=user-42&status=active" \ -H "x-api-key: YOUR_API_KEY" ``` ```json theme={null} { "count": 1, "next": null, "previous": null, "results": [ { "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f", "vendor_data": "user-42", "source_type": "session_delete", "provenance_reference": "6b1e8d2f-4a3c-4f9e-8c7d-1a2b3c4d5e6f", "retention_policy": "retain_until_user_deleted", "retention_override": null, "retained_at": "2026-08-28T10:15:42.318402Z", "expires_at": "2027-08-28T10:15:42.318402Z", "retained_by": "3c9e2b1f-7d4a-4e8b-9c1d-5f6a7b8c9d0e", "retained_by_type": "API_KEY", "instruction_class": "operational_session_delete", "instruction_source": "api", "instruction_id": "post-approval-cleanup-2026-08", "held_out_of_use": false, "status": "active", "purged_at": null } ] } ``` See the [overview](/management-api/biometric-templates/overview#template-object) for every field. ## Errors | Status | When | | ------ | ------------------------------------------------------------------- | | `400` | Invalid filter value, or `retained_to` earlier than `retained_from` | | `403` | Console user token, or the API key is not allowed | ## OpenAPI ````yaml GET /v3/biometric-templates/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: Identity verification API. Authenticate with x-api-key header. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/biometric-templates/: get: tags: - Biometric Templates summary: List retained biometric templates description: >- An opted-in application keeps one separately managed, image-free face biometric template anchored to the User when a session is deleted (see `DELETE /v3/session/{sessionId}/delete/`). Templates are biometric data with a finite `expires_at`; they never contain images, session data, or identity fields, and they are purged on User deletion, privacy erasure, expiry, or an explicit purge. These endpoints accept application API keys (`x-api-key`) only; Business Console user tokens are rejected with `403`. Returns a paginated list of the templates the application currently holds. Purged templates are not listed. operationId: list_biometric_templates parameters: - in: query name: vendor_data required: false description: >- Case-insensitive substring match on the owning User's current `vendor_data`. schema: type: string - in: query name: vendor_user_uuid required: false description: Exact match on the owning User. schema: type: string format: uuid - in: query name: status required: false description: Lifecycle status. Purged templates are never listed. schema: type: string enum: - pending - active - expired - held_out_of_use - purge_pending - purge_failed - in: query name: source_type required: false description: How the template was created. schema: type: string enum: - session_delete - automatic_retention - backfill - in: query name: retained_from required: false description: Templates retained at or after this time. schema: type: string format: date-time - in: query name: retained_to required: false description: >- Templates retained at or before this time. Must not be earlier than `retained_from` (`400`). schema: type: string format: date-time - in: query name: ordering required: false description: Sort order. schema: type: string enum: - retained_at - '-retained_at' - expires_at - '-expires_at' default: '-retained_at' - in: query name: limit required: false description: Page size. schema: type: integer - in: query name: offset required: false description: Pagination offset. schema: type: integer responses: '200': description: Paginated templates. content: application/json: schema: type: object properties: count: type: integer next: type: string nullable: true previous: type: string nullable: true results: type: array items: type: object properties: uuid: type: string format: uuid description: >- Template id. Randomly generated; not derived from the deleted session or its face. vendor_user_uuid: type: string format: uuid description: The owning User. vendor_data: type: string nullable: true description: >- The User's current `vendor_data`, resolved when you read the template (never copied). source_type: type: string enum: - session_delete - automatic_retention - backfill description: >- How the template was created: a session deletion (API or Console), the application's automatic data-retention window, or a Didit-operated backfill you instructed. provenance_reference: type: string format: uuid description: >- Opaque reference tying the template to its audit trail. It is not the deleted session's id and cannot be resolved to it. retention_policy: type: string enum: - delete_with_session - retain_until_user_deleted description: The application policy at retention time. retention_override: type: boolean nullable: true description: >- The `retain_face_embeddings` value sent on the deletion, or `null` when the policy applied. retained_at: type: string format: date-time expires_at: type: string format: date-time description: >- When the template expires and is purged automatically. Always set. retained_by: type: string nullable: true description: >- Principal that gave the instruction: the application id for API keys, the Console member id for Console actions, or a `service:` identifier for automatic retention. Never an email address. retained_by_type: type: string enum: - API_KEY - CONSOLE_USER - SYSTEM instruction_class: type: string enum: - operational_session_delete - privacy_erasure instruction_source: type: string enum: - api - console - automatic_retention - backfill - privacy_erasure - explicit_template_purge - vendor_user_delete - expiry - reconciliation - migration - system instruction_id: type: string description: >- The `instruction_id` sent on the deletion, or a Didit-generated id. held_out_of_use: type: boolean description: >- `true` only while a legal hold applies. A held template is excluded from all matching. status: type: string enum: - pending - active - expired - held_out_of_use - purge_pending - purge_failed - purged description: >- Only `active` templates that are not held, not past `expires_at`, and whose User still exists take part in matching. purged_at: type: string format: date-time nullable: true examples: One active template: value: count: 1 next: null previous: null results: - uuid: 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b vendor_user_uuid: 2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f vendor_data: user-42 source_type: session_delete provenance_reference: 6b1e8d2f-4a3c-4f9e-8c7d-1a2b3c4d5e6f retention_policy: retain_until_user_deleted retention_override: null retained_at: '2026-08-28T10:15:42.318402Z' expires_at: '2027-08-28T10:15:42.318402Z' retained_by: 3c9e2b1f-7d4a-4e8b-9c1d-5f6a7b8c9d0e retained_by_type: API_KEY instruction_class: operational_session_delete instruction_source: api instruction_id: post-approval-cleanup-2026-08 held_out_of_use: false status: active purged_at: null '400': description: >- Invalid filter value, or `retained_to` earlier than `retained_from`. Field-keyed validation errors. content: application/json: examples: Bad range: value: retained_to: - Must be on or after retained_from. '403': description: >- Console user token, or the API key is not allowed. These endpoints accept application API keys only. 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/?vendor_data=user-42&status=active' \ -H 'x-api-key: YOUR_API_KEY' components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key ````