Get Project

Endpoint

GET https://api.verifik.co/v3/projects/{id}

Retrieve detailed information about a specific project by its ID.

Headers

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

Params

Name	Type	Required	Description
id	string	Yes	The unique identifier of the project

Request

Node.js

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

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

run();

PHP

<?php
$projectId = "64a1b2c3d4e5f6789012345";
$ch = curl_init("https://api.verifik.co/v3/projects/" . $projectId);
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

project_id = "64a1b2c3d4e5f6789012345"
url = f"https://api.verifik.co/v3/projects/{project_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() {
    projectId := "64a1b2c3d4e5f6789012345"
    url := fmt.Sprintf("https://api.verifik.co/v3/projects/%s", projectId)
    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": "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,
        "demoOTP": null,
        "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": []
                                },
                                {
                                    "active": true,
                                    "documentCategory": "passport",
                                    "documentTemplates": []
                                }
                            ]
                        },
                        {
                            "country": "Canada",
                            "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": ""
                },
                "createdAt": "2023-07-01T10:00:00.000Z",
                "updatedAt": "2023-07-01T15:30:00.000Z"
            }
        ],
        "version": 2,
        "createdAt": "2023-07-01T10:00:00.000Z",
        "updatedAt": "2023-07-01T15:30:00.000Z"
    }
}

400

{
    "message": "Invalid project ID format",
    "code": "InvalidParameter"
}

401/403

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

404

{
    "message": "Project not found",
    "code": "NotFound"
}

Notes

• Project Flows: The projectFlows array contains all associated flows for the project. For personal targets, you'll typically see one onboarding flow.
• Demo Mode: When demoMode is true, the project is configured for testing purposes and may have different behavior in production. The demoOTP field is encrypted or null if not in demo mode.
• Status Values: Project status can be draft, active, or paused.
• Configuration Steps: currentStep and lastStep indicate the project's configuration progress (0-6 steps).
• Branding: Complete branding configuration including colors, logos, and images for customizing the verification UI.
• Data Protection: Full data protection officer (DPO) information is included for compliance requirements.