Retrieve a Collection

Endpoint

GET https://api.verifik.co/v2/face-recognition/collections/{id}

Fetch a collection using its unique _id. Do not confuse this with the collection code (UUID) used in some other APIs.

Headers

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

Params

Name	Type	Required	Description
id	string (path)	Yes	Unique identifier of the collection (_id in responses)

Request

Node.js

const fetch = require("node-fetch");

const collectionId = "65b9592267cc4f096dbe743d";

async function run() {
  const res = await fetch(
    `https://api.verifik.co/v2/face-recognition/collections/${collectionId}`,
    {
      method: "GET",
      headers: {
        "Content-Type": "application/json",
        Authorization: `Bearer ${process.env.VERIFIK_TOKEN}`,
      },
    }
  );
  console.log(await res.json());
}

run();

PHP

<?php
$collectionId = "65b9592267cc4f096dbe743d";
$ch = curl_init("https://api.verifik.co/v2/face-recognition/collections/" . $collectionId);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: Bearer " . getenv("VERIFIK_TOKEN")
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Python

import os, requests

collection_id = "65b9592267cc4f096dbe743d"
url = f"https://api.verifik.co/v2/face-recognition/collections/{collection_id}"
headers = {
    "Content-Type": "application/json",
    "Authorization": f"Bearer {os.getenv('VERIFIK_TOKEN')}"
}
r = requests.get(url, headers=headers)
print(r.json())

Go

package main

import (
    "encoding/json"
    "fmt"
    "net/http"
    "os"
)

func main() {
    collectionId := "65b9592267cc4f096dbe743d"
    url := fmt.Sprintf("https://api.verifik.co/v2/face-recognition/collections/%s", collectionId)
    req, _ := http.NewRequest("GET", url, nil)
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer "+os.Getenv("VERIFIK_TOKEN"))
    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()
    var out map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&out)
    fmt.Println(out)
}

Response

200

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

401/403

{
    "message": "Access forbidden",
    "code": "Forbidden"
}

404

{
  "message": "invalid_collection",
  "code": "ERROR"
}

400

{
  "error": "Invalid request"
}

Notes

• id vs code: This route uses the _id from the collection document, not the code field.
• Single object: The response wraps one collection in data.