Skip to main content

The Collection Object

Overview​

A Collection is the place where all the faces generated using Verifik's Life Detection services will be stored. The majority of services require a Collection for their operation, making it crucial to understand how to generate a Collection and manipulate it at the API level.

Attributes​

name​

Type: String
Required: Yes

Name that you want to put to the collection.

description​

Type: String
Required: Yes

Brief description of what the collection is going to be used for or anything that you want to add.

_id​

Type: ObjectId
Required: Yes

Unique identifier for the collection.

deleted​

Type: Boolean
Required: Yes

Whether the collection has been marked as deleted (soft delete).

project​

Type: ObjectId
Required: Yes

Reference to the Project model, linking the collection to a specific project.

client​

Type: ObjectId
Required: Yes

Reference to the Client model, linking the collection to a specific client account.

code​

Type: String
Required: Yes

Unique code for the collection used in API operations (referred to as collection_id when requested).

createdAt​

Type: Date
Required: Yes

Timestamp when the collection was created.

updatedAt​

Type: Date
Required: Yes

Timestamp when the collection was last updated.

__v​

Type: Number
Required: Yes

Version key for the collection object.

Example Object​

{
  "_id": "65b9592267cc4f096dbe743d",
  "deleted": false,
  "name": "Ejemplo Ene 30",
  "project": "65b955fe0577440932c77481",
  "description": "default collection for project 65b955fe0577440932c77481",
  "client": "6158e492dd0767a2b8b3f829",
  "code": "d96db430-27d2-4f43-bcff-c4b239ac6d2e",
  "updatedAt": "2024-01-30T20:16:34.841Z",
  "createdAt": "2024-01-30T20:16:34.841Z",
  "__v": 0
}