Retrieve an app registration

Endpoint

https://api.verifik.co/v2/app-registrations/{id}

Optional query parameters

populates[] (optional): Use this to populate additional related data. The available populates are:
- project: Retrieves associated project details.
- projectFlow: Retrieves associated project flow details.
- emailValidation: Retrieves the status and details of email validation.
- phoneValidation: Retrieves the status and details of phone validation.
- biometricValidation: Retrieves the status and details of biometric validation.

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>

Request

curl -X GET "https://verifik.co/api/v2/app-registrations/{appRegistrationId}?populates[]=project&populates[]=projectFlow" \
-H "Authorization: JWT YOUR_JWT_TOKEN" \
-H "Content-Type: application/json"

const axios = require('axios');

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

axios.request(config)
  .then(response => {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch(error => {
    console.error(error);
  });

import Foundation

let url = URL(string: "https://verifik.co/api/v2/app-registrations/{appRegistrationId}?populates[]=project&populates[]=projectFlow")!
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 Registration, Status Code:", (response as? HTTPURLResponse)?.statusCode ?? 0)
    }
}

task.resume()

import okhttp3.OkHttpClient
import okhttp3.Request
import okhttp3.Response

val client = OkHttpClient()

val request = Request.Builder()
    .url("https://verifik.co/api/v2/app-registrations/{appRegistrationId}?populates[]=project&populates[]=projectFlow")
    .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 Registration, Status Code: ${response.code}")
    }
}

Response

On a successful request, you’ll receive a JSON response containing the app registration data, which includes details about the project, validation statuses, and other key information.

{
    "data": {
        "language": "en",
        "failedEmailValidations": [],
        "failedPhoneValidations": [],
        "failedBiometricValidations": [],
        "failedDocumentValidations": [],
        "_id": "658b3dbca0f6aa080f714844",
        "status": "STARTED",
        "redFlags": 0,
        "deleted": false,
        "client": "613375a1eab2fe08527f81e2",
        "project": {
            "dataProtection": {
                "name": "Miguel T",
                "email": "[email protected]",
                "address": null,
                "address2": null,
                "city": null,
                "postalCode": null,
                "country": null
            },
            "branding": {
                "bgColor": "#F2FFF8",
                "borderColor": "#B2BDD3",
                "buttonColor": "#14AE5C",
                "buttonTxtColor": "#FFF",
                "txtColor": "#8e9713",
                "titleColor": "#0057F8",
                "logo": "https://cdn.verifik.co/projects/VerifikClientApp_1726146056389-image.png",
                "rightImage": "https://cdn.verifik.co/assets/auth/authb.svg",
                "rightImagePosition": "center center",
                "rightBackgroundColor": "#FFF"
            },
            "_id": "6266193db77ccc8111730c90",
            "passwordLessOptions": {
                "email": true,
                "whatsapp": true,
                "sms": true,
                "qr": true,
                "biometrics": true
            },
            "status": "active",
            "name": "Verifik Client App",
            "client": "613375a1eab2fe08527f81e2",
            "updatedAt": "2024-10-25T18:13:55.021Z",
            "createdAt": "2022-04-25T03:45:01.619Z",
            "__v": 16,
            "contactEmail": "[email protected]",
            "privacyUrl": "https://legal.verifik.co/politicas-de-privacidad",
            "termsAndConditionsUrl": "https://legal.verifik.co/terminos-y-condiciones",
            "type": "login",
            "currentStep": 1,
            "allowedCountries": [
                "Canada",
                "Colombia",
                "Mexico",
                "Panama",
                "United States",
                "Chile"
            ],
            "lastStep": 6,
            "assignedCollection": "65987dc37ca096050ef1d47a",
            "collectionCode": "314d321e-86f6-46b0-8988-d4e2cef39eb5",
            "projectMembers": [
                "65e0999d7c0d3207c944a752",
                "65e0999f918af74b42b1e9d6",
                "65e099e0918af74b42b1e9e0",
                "6625f14b8766114ad40d52d0"
            ]
        },
        "projectFlow": null,
        "email": "josé[email protected]",
        "countryCode": "+1",
        "phone": "1678304497",
        "currentStep": "1",
        "updatedAt": "2023-12-26T20:55:24.298Z",
        "createdAt": "2023-12-26T20:55:24.298Z",
        "__v": 0
    }
}

{
    "code": "NotFound",
    "message": "Record not found."
}

Key Fields Explained

status: Current status of the app registration (e.g., STARTED, ONGOING, etc.).
project: Contains project details such as branding, data protection contact, password-less options, allowed countries, and more.
language: Language preference for this registration.
redFlags: Indicates any issues detected during the validation process.
client: Client ID associated with this registration.
email, countryCode, phone: Contact details for the app registration.
failedValidations: Lists of failed validation types (email, phone, biometric, document).
projectFlow: the project flow process related to this app registration.

Notes

Populates: Using populates lets you retrieve additional linked data in a single request. The supported populates are:
- project: Full details of the associated project, including branding and data protection settings.
- projectFlow: Information about the workflow or flow process tied to this app registration.
- emailValidation: Email validation status and details.
- phoneValidation: Phone validation status and details.
- biometricValidation: Biometric validation status and details.

By using this endpoint with the appropriate populates, you can gain a comprehensive view of an App Registration, along with its related project and validation details.

PreviousSync app registration status NextList all app registrations

Last updated 6 months ago