El Objeto Colección

Descripción General

Una Colección es el lugar donde se almacenarán todos los rostros generados utilizando los servicios de Detección de Vida de Verifik. La mayoría de los servicios requieren una Colección para su operación, por lo que es crucial entender cómo generar una Colección y manipularla a nivel de API.

Atributos

name

Tipo: String
Requerido: Sí

Nombre que deseas asignar a la colección.

description

Tipo: String
Requerido: Sí

Breve descripción de para qué se va a utilizar la colección o cualquier cosa que desees agregar.

_id

Tipo: ObjectId
Requerido: Sí

Identificador único para la colección.

deleted

Tipo: Boolean
Requerido: Sí

Si la colección ha sido marcada como eliminada (eliminación lógica).

project

Tipo: ObjectId
Requerido: Sí

Referencia al modelo de Proyecto, vinculando la colección a un proyecto específico.

client

Tipo: ObjectId
Requerido: Sí

Referencia al modelo de Cliente, vinculando la colección a una cuenta de cliente específica.

code

Tipo: String
Requerido: Sí

Código único para la colección utilizado en operaciones de API (referido como collection_id cuando se solicita).

createdAt

Tipo: Date
Requerido: Sí

Marca de tiempo cuando se creó la colección.

updatedAt

Tipo: Date
Requerido: Sí

Marca de tiempo cuando se actualizó la colección por última vez.

__v

Tipo: Number
Requerido: Sí

Clave de versión para el objeto colección.

Objeto de Ejemplo

{
  "_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
}