Recuperar un registro en la app
Endpoint
https://api.verifik.co/v2/app-registrations/{id}
Parámetros de Consulta Opcionales
populates[] (opcional): Se usa para llenar datos adicionales relacionados con el registro. Las opciones disponibles son:
project: Recupera los detalles del proyecto asociado.
projectFlow: Recupera los detalles del flujo de proyecto asociado.
emailValidation: Recupera el estado y los detalles de la validación por correo electrónico.
phoneValidation: Recupera el estado y los detalles de la validación por teléfono.
biometricValidation: Recupera el estado y los detalles de la validación biométrica.
Encabezados (Headers)
Incluye los encabezados de autenticación necesarios, así como otros requeridos para autorización y tipo de contenido, como:
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"
Respuesta
En una solicitud exitosa, recibirás una respuesta en formato JSON que contendrá los datos del App Registration, incluyendo Detalles del proyecto asociado, estados de validación y otra información clave sobre el registro.
{
"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
}
}
Explicación de Campos Clave
status: Estado actual del App Registration (ejemplo: STARTED, ONGOING, COMPLETED, etc.).
project: Contiene detalles del proyecto, como marca, contacto para protección de datos, opciones sin contraseña, países permitidos, y más.
language: Preferencia de idioma para este registro.
redFlags: Indica problemas detectados durante el proceso de validación.
client: ID del cliente asociado con este registro.
email, countryCode, phone: Información de contacto utilizada en el registro de la aplicación.
failedValidations: Lista de tipos de validaciones fallidas (email, phone, biometric, document).
projectFlow: Flujo del proyecto relacionado con este App Registration.
Notas
Populates El uso de populates permite recuperar datos adicionales vinculados en una única solicitud. Los populates compatibles son:
project: Información completa del proyecto asociado, incluyendo marca y configuraciones de protección de datos.
projectFlow: Información sobre el flujo del proceso vinculado a este App Registration.
emailValidation: Estado y detalles de la validación por correo electrónico.
phoneValidation: Estado y detalles de la validación por teléfono.
biometricValidation: Estado y detalles de la validación biométrica.
Al utilizar este endpoint con los populates adecuados, se obtiene una vista completa de un App Registration, junto con sus detalles relacionados con el proyecto y la validación.
Last updated