List all app registrations

Endpoint

https://api.verifik.co/v2/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.

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 -X GET "https://verifik.co/api/v2/app-registrations" \
-H "Authorization: JWT YOUR_JWT_TOKEN" \
-H "Content-Type: application/json"

Response

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

{
    "data": [
        {
            "_id": "671bed04409569ff02f0b45d",
            "client": "671a7f594e3bb7129d1d89af",
            "project": "671be9e7409569ff02f0b3b5",
            "projectFlow": "671be9f9409569ff02f0b3be",
            "status": "ONGOING",
            "email": "rogelio_197725@verifik.co",
            "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"
        }
    ]
}

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.

Last updated