Retrieve an app registration
Last updated
Last updated
GET - 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.
Include the necessary authentication headers, as well as any other headers required for authorization and content-type, such as:
Name | Value |
---|---|
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.
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.
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.
Content-Type
application/json
Authorization
Bearer <token>