Create a Collection

POST - https://api.verifik.co/v2/face-recognition/collections

A Project is where all the information related to the company or entity that will use the authentication and validation services generated by Verifik is stored. This is done to ensure that your brand is represented correctly when using Verifik's services.

Implementation

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
name	string	Name of the project.
description	String	Brief description of what the collection will be used for.

Body example

{
  "name": "Name to be given to the Collection",
  "description": "Name to be given to the Collection"
}

Response

200

{
  "data": {
    "__v": 0,
    "_id": "65175da13e81e4fabc12345",
    "code": "dac2c81b-96a6-4f19-ab54-d1a72d55b64b",
    "name": "Test Example",
    "client": "65175da13e81e4fabc12345",
    "deleted": false,
    "createdAt": "2023-09-29T23:28:33.894Z",
    "updatedAt": "2023-09-29T23:28:33.894Z",
    "description": "Example on how to create a colection"
  }
}

400

{
  "error": "Invalid request"
}

While all these parameters are useful, the one we are looking for is called code. This parameter will be the one we use from now on when requested. When requested, it will be referred to as collection_id.