Skip to main content
GET
curl
Returns the number of templates that match the same filters as List Biometric Templates. Purged templates are not counted.
Use it to show the total on a dashboard, or to check what a filtered bulk purge with delete_all: true would touch before you run it.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Query Parameters

vendor_data
string

Case-insensitive substring match on the owning User's current vendor_data.

vendor_user_uuid
string<uuid>

Exact match on the owning User.

status
enum<string>

Lifecycle status. Purged templates are never listed.

Available options:
pending,
active,
expired,
held_out_of_use,
purge_pending,
purge_failed
source_type
enum<string>

How the template was created.

Available options:
session_delete,
automatic_retention,
backfill
retained_from
string<date-time>

Templates retained at or after this time.

retained_to
string<date-time>

Templates retained at or before this time. Must not be earlier than retained_from (400).

Response

Count.

count
integer
Required range: x >= 0