List App Registrations

Endpoint

GET https://api.verifik.co/v2/app-registrations

Retrieve a paginated list of all app registrations associated with the authenticated user. You can filter by status, project, and other criteria.

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)
where_status	string	No	Filter by status (STARTED, ONGOING, COMPLETED, COMPLETED_WITHOUT_KYC, FAILED, NEEDS_MANUAL_VERIFICATION, EXPIRED)
where_project	string	No	Filter by project ID
where_projectFlow	string	No	Filter by project flow ID
in_status	array	No	Filter by multiple statuses (["ONGOING", "COMPLETED"])
populates[]	array	No	Populate related objects. Available: project, projectFlow, emailValidation, phoneValidation, biometricValidation, documentValidation, informationValidation, person

Request

Node.js

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

async function run() {
    const res = await fetch("https://api.verifik.co/v2/app-registrations?page=1&limit=10&where_status=ONGOING", {
        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/v2/app-registrations?page=1&limit=10&where_status=ONGOING");
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/v2/app-registrations"
headers = {
    "Content-Type": "application/json",
    "Authorization": f"Bearer {os.getenv('VERIFIK_TOKEN')}"
}
params = {"page": 1, "limit": 10, "where_status": "ONGOING"}
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/v2/app-registrations?page=1&limit=10&where_status=ONGOING", 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": "674de8df21c72be3cc42b8a7",
            "client": "507f1f77bcf86cd799439013",
            "project": "507f1f77bcf86cd799439011",
            "projectFlow": "507f1f77bcf86cd799439015",
            "status": "ONGOING",
            "email": "user@example.com",
            "phone": "1234567890",
            "countryCode": "+1",
            "currentStep": "1",
            "language": "en",
            "createdAt": "2024-12-02T17:05:36.788Z",
            "updatedAt": "2024-12-02T17:05:36.788Z"
        }
    ],
    "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=ONGOING&where_project=507f1f77bcf86cd799439011
• Multiple Statuses: Use in_status as an array to filter by multiple statuses: ?in_status[]=ONGOING&in_status[]=COMPLETED
• Response Metadata: The response includes total (total count), limit, page, and pages for pagination control.
• Populates: Use populates[] to include related objects in the response, reducing the need for additional API calls.