List Projects

Endpoint

GET https://api.verifik.co/v3/projects

Retrieve a paginated list of all projects associated with the authenticated user.

Headers

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

Params

Name	Type	Required	Description
page	integer	No	Page number (default: 1)
limit	integer	No	Number of items per page (default: 10, max: 100)
like_name	string	No	Search term for project name
where_status	string	No	Filter by project status (draft, active, paused)
where_target	string	No	Filter by project target (personal, business)
where_createdAt	string	No	Filter by creation date (ISO 8601 format)
in_status	array	No	Filter by multiple statuses (["active", "paused"])

Request

Node.js

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

async function run() {
  const res = await fetch("https://api.verifik.co/v3/projects?page=1&limit=10", {
    method: "GET",
    headers: {
      "Content-Type": "application/json",
      Authorization: `Bearer ${process.env.VERIFIK_TOKEN}`,
    },
  });
  console.log(await res.json());
}

run();

PHP

<?php
$ch = curl_init("https://api.verifik.co/v3/projects?page=1&limit=10");
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

url = "https://api.verifik.co/v3/projects"
headers = {
    "Content-Type": "application/json",
    "Authorization": f"Bearer {os.getenv('VERIFIK_TOKEN')}"
}
params = {"page": 1, "limit": 10}
r = requests.get(url, params=params, headers=headers)
print(r.json())

Go

package main

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

func main() {
    req, _ := http.NewRequest("GET", "https://api.verifik.co/v3/projects?page=1&limit=10", 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": "64a1b2c3d4e5f6789012345",
            "name": "My KYC Project",
            "identifier": "my-kyc-project",
            "contactEmail": "admin@example.com",
            "privacyUrl": "https://example.com/privacy",
            "termsAndConditionsUrl": "https://example.com/terms",
            "status": "active",
            "currentStep": 6,
            "lastStep": 6,
            "demoMode": false,
            "allowedCountries": ["United States", "Canada"],
            "dataProtection": {
                "name": "John Doe",
                "email": "dpo@example.com",
                "address": "123 Main St",
                "address2": "Suite 100",
                "city": "New York",
                "country": "United States",
                "postalCode": "10001"
            },
            "branding": {
                "backgroundColor": "#01236D",
                "buttonColor": "#B2BDD3",
                "buttonTextColor": "#FFFFFF",
                "textColor": "#8091B6",
                "titleColor": "#000000",
                "logo": "https://example.com/logo.png",
                "image": "https://example.com/hero-image.png",
                "imageBackgroundColor": "white",
                "backgroundImage": null,
                "backgroundImageColor": ""
            },
            "projectFlows": [
                {
                    "_id": "64a1b2c3d4e5f6789012346",
                    "type": "onboarding",
                    "target": "personal",
                    "status": "active",
                    "version": 3,
                    "redirectUrl": "https://example.com/success",
                    "webhookUrl": "https://example.com/webhook",
                    "signUpForm": {
                        "fullName": true,
                        "fullNameStyle": "separate",
                        "email": true,
                        "emailGateway": "mailgun",
                        "phone": true,
                        "phoneGateway": "whatsapp",
                        "countryCode": "US",
                        "showTermsAndConditions": true,
                        "showPrivacyNotice": true,
                        "allowAdditionalFields": false,
                        "additionalFields": []
                    },
                    "documents": {
                        "attemptLimit": 3,
                        "criminalHistoryVerification": true,
                        "informationVerification": true,
                        "screening": true,
                        "verificationMethods": ["SCAN_PROMPT"],
                        "documentTypes": [
                            {
                                "country": "United States",
                                "configurations": [
                                    {
                                        "active": true,
                                        "documentCategory": "government_id",
                                        "documentTemplates": []
                                    }
                                ]
                            }
                        ]
                    },
                    "liveness": {
                        "attemptLimit": 3,
                        "minScore": 0.65,
                        "searchMinScore": 0.8,
                        "searchMode": "FAST"
                    },
                    "steps": {
                        "document": "mandatory",
                        "liveness": "mandatory"
                    },
                    "integrations": {
                        "redirectUrl": "https://example.com/success",
                        "webhook": "64a1b2c3d4e5f6789012347",
                        "source": "NONE",
                        "strategy": "none",
                        "apiUrl": "",
                        "apiTestType": "email",
                        "apiTestValue": ""
                    }
                }
            ],
            "version": 2,
            "createdAt": "2023-07-01T10:00:00.000Z",
            "updatedAt": "2023-07-01T15:30:00.000Z"
        }
    ],
    "total": 1,
    "limit": 10,
    "page": 1,
    "pages": 1
}

401/403

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

409

{
    "message": "Invalid parameter: limit must be between 1 and 100",
    "code": "MissingParameter"
}

Notes

• Pagination: Use page and limit parameters to navigate through results. Default limit is 10 items per page, maximum is 100.
• Filtering: Combine multiple query parameters to filter results. Example: ?where_status=active&like_name=kyc
• Search: The like_name parameter performs a case-insensitive search on project names.
• Multiple Statuses: Use in_status as an array to filter by multiple statuses: ?in_status[]=active&in_status[]=paused
• Response Metadata: The response includes total (total count), limit, page, and pages for pagination control.
• Project Flows: Each project includes its associated projectFlows array with complete configuration details.