List all app registrations

This endpoint allows you to retrieve a list of all App Registrations within the Verifik API. You can use this to get a detailed overview of multiple app registrations, including their status, associated project, validation statuses, and more.

Endpoint

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

Headers

Include the necessary authentication headers, as well as any other headers required for authorization and content-type, such as:

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

Query Params

Here’s a table format for the query parameters used in this API call. This will clearly show what each populate parameter does by converting ObjectId references into the corresponding objects.

Parameter	Value	Description
page	1	Specifies the page number for pagination, starting from 1.
perPage	20	Defines the number of items per page for pagination.
populates[]=emailValidation	emailValidation	Populates the emailValidation field, transforming it from an ObjectId reference into the full emailValidation object, including details such as validation status.
populates[]=phoneValidation	phoneValidation	Populates the phoneValidation field, converting the ObjectId into the full phoneValidation object with validation details.
populates[]=informationValidation	informationValidation	Populates informationValidation, replacing the ObjectId with the full informationValidation object, containing information-related validation details.
populates[]=biometricValidation	biometricValidation	Populates the biometricValidation field, providing the full biometricValidation object details instead of just the ObjectId.
populates[]=documentValidation	documentValidation	Populates the documentValidation field, replacing the ObjectId with the full documentValidation object containing document verification data.
populates[]=documentFace	documentFace	Populates the documentFace field, replacing the ObjectId with the full documentFace object, which includes details of the document's face comparison.
populates[]=failedBiometricValidations	failedBiometricValidations	Populates the failedBiometricValidations field, returning full objects for each failed biometric validation.
populates[]=project	project	Populates the project field, providing the full project details such as branding, allowed countries, and status, instead of just an ObjectId.
populates[]=projectFlow	projectFlow	Populates the projectFlow field, transforming the ObjectId into the full project flow object containing the flow setup and related details.
where_status=<status>	ONGOING	Where condition to filter by status where the options are specified here

Request

cURL

curl -X GET "https://verifik.co/api/v2/app-registrations" \
-H "Authorization: JWT YOUR_JWT_TOKEN" \
-H "Content-Type: application/json"

Node.js

const axios = require('axios');

let config = {
  method: 'get',
  url: 'https://verifik.co/api/v2/app-registrations',
  headers: {
    'Authorization': 'Bearer YOUR_JWT_TOKEN'
  }
};

axios.request(config)
  .then(response => {
    console.log({data: response.data});
  })
  .catch(error => {
    console.error(error);
  });

Swift

import Foundation

let url = URL(string: "https://verifik.co/api/v2/app-registrations")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.setValue("JWT YOUR_JWT_TOKEN", forHTTPHeaderField: "Authorization")

let task = URLSession.shared.dataTask(with: request) { data, response, error in
    guard let data = data, error == nil else {
        print("Error:", error ?? "Unknown error")
        return
    }
    
    if let httpResponse = response as? HTTPURLResponse, httpResponse.statusCode == 200 {
        do {
            let jsonResponse = try JSONSerialization.jsonObject(with: data, options: [])
            print("Response JSON:", jsonResponse)
        } catch {
            print("Error parsing JSON:", error)
        }
    } else {
        print("Failed to fetch App Registrations, Status Code:", (response as? HTTPURLResponse)?.statusCode ?? 0)
    }
}

task.resume()

Kotlin

import okhttp3.OkHttpClient
import okhttp3.Request

val client = OkHttpClient()

val request = Request.Builder()
    .url("https://verifik.co/api/v2/app-registrations")
    .get()
    .addHeader("Authorization", "JWT YOUR_JWT_TOKEN")
    .build()

client.newCall(request).execute().use { response ->
    if (response.isSuccessful) {
        response.body?.string()?.let {
            println("Response JSON: $it")
        }
    } else {
        println("Failed to fetch App Registrations, Status Code: ${response.code}")
    }
}

Response

On a successful request, you’ll receive a JSON response containing a list of app registrations, with details for each registration.

200

{
    "data": [
        {
            "_id": "671bed04409569ff02f0b45d",
            "client": "671a7f594e3bb7129d1d89af",
            "project": "671be9e7409569ff02f0b3b5",
            "projectFlow": "671be9f9409569ff02f0b3be",
            "status": "ONGOING",
            "email": "[e-mail]",
            "countryCode": "+57",
            "phone": "2650270837",
            "currentStep": "signUpForm",
            "redFlags": 0,
            "language": "en",
            "failedEmailValidations": [],
            "failedPhoneValidations": [],
            "failedBiometricValidations": [],
            "failedDocumentValidations": [
                "671bf011409569ff02f0b5b9"
            ],
            "informationValidation": "671bed04409569ff02f0b45e",
            "name": "Rogelio Martín",
            "accessControlLog": "671bed04409569ff02f0b461",
            "updatedAt": "2024-10-25T19:35:36.390Z",
            "createdAt": "2024-10-25T19:09:56.718Z",
            "__v": 1,
            "documentFace": "671bf02a409569ff02f0b5c9",
            "documentValidation": "671bf02a409569ff02f0b5c6"
        }
    ]
}

200 - Paginated

{
    "data": [
        {
            "_id": "67098c8399d91d35cafe1d79",
            "client": "613a3a48f2c84b454153add7",
            "project": "663bd7e94a262144c9313cf0",
            "projectFlow": "663bd7f44a262144c9313cf6",
            "status": "ONGOING",
            "email": "[e-mail]",
            "countryCode": "+57",
            "phone": "7747498134",
            "currentStep": "signUpForm",
            "redFlags": 0,
            "language": "en",
            "failedEmailValidations": [],
            "failedPhoneValidations": [],
            "failedBiometricValidations": [],
            "failedDocumentValidations": [],
            "informationValidation": "67098c8399d91d35cafe1d7a",
            "name": "Robert López",
            "accessControlLog": "67098c8399d91d35cafe1d7d",
            "updatedAt": "2024-10-11T20:51:57.915Z",
            "createdAt": "2024-10-11T20:37:23.558Z",
            "__v": 0,
            "emailValidation": "67098c8599d91d35cafe1d8f",
            "phoneValidation": "67098c8b99d91d35cafe1daa",
            "documentFace": "67098cc699d91d35cafe1dd6",
            "documentValidation": "67098cc699d91d35cafe1dd3"
        },
        {
            "_id": "66901a15d2e44d3323d88439",
            "client": "613a3a48f2c84b454153add7",
            "project": "663bd9e94a262144c9313d3f",
            "projectFlow": "6690162b1fb3ea6aed69e616",
            "status": "ONGOING",
            "email": "[e-mail]",
            "countryCode": "+1",
            "phone": "7917290632",
            "currentStep": "instructions",
            "redFlags": 0,
            "language": "es",
            "failedEmailValidations": [],
            "failedPhoneValidations": [],
            "failedBiometricValidations": [],
            "failedDocumentValidations": [],
            "informationValidation": "66901a15d2e44d3323d8843a",
            "name": "Robert González",
            "accessControlLog": "66901a15d2e44d3323d8843d",
            "updatedAt": "2024-07-11T17:57:51.392Z",
            "createdAt": "2024-07-11T17:44:53.814Z",
            "__v": 0,
            "emailValidation": "66901a16d2e44d3323d8844d",
            "phoneValidation": "66901a1bd2e44d3323d88466",
            "documentFace": "66901af5d2e44d3323d884fb",
            "documentValidation": "66901af5d2e44d3323d884f8",
            "biometricValidation": null,
            "face": null,
            "person": null,
            "compareFaceVerification": null
        },
        ...
    ],
    "total": 12,
    "limit": 20,
    "page": 1,
    "pages": 1
}

Key Fields Explained

• _id: Unique identifier for the app registration.

• client: Client ID associated with this registration.

• project: Project ID associated with this registration.

• projectFlow: Project Flow ID associated with this registration.

• status: Current status of the app registration (e.g., ONGOING, COMPLETED).

• email: Email address linked to this registration.

• phone: Phone number linked to this registration.

• currentStep: The current step in the registration process.

• failedValidations: Lists failed validations for email, phone, biometric, and document.

• informationValidation: ID for information validation associated with this registration.

• updatedAt: Timestamp of the last update for this registration.

• createdAt: Timestamp when this registration was created.