Crear un registro en la app
Endpoint:
https://api.verifik.co/v2/app-registrations
Un App Registration es una instancia dentro del sistema de Verifik que permite a un usuario iniciar el proceso de autenticación y validación utilizando flujos de proyectos específicos, junto con detalles de correo electrónico y/o teléfono. Este proceso garantiza la identidad del usuario y proporciona una validación segura a través de varios pasos de verificación.
Encabezados (Headers)
Incluye los encabezados de autenticación necesarios, así como otros requeridos para la autorización y el tipo de contenido, tales como:
Content-Type
application/json
Authorization
Bearer <token>
Body
project - ObjectId - Requerido ID único del proyecto asociado con este registro.
projectFlow - ObjectId - Requerido ID único del Project Flow que define el proceso de registro y validación.
email - String - Opcional Dirección de correo electrónico del usuario a registrar. (Se requiere al menos email o phone).
phone - String - Opcional Número de teléfono del usuario a registrar. (Se requiere al menos phone o email).
countryCode - String - Opcional Código de país asociado con el número de teléfono. (Obligatorio si se proporciona un teléfono).
language - String - Opcional Idioma preferido para la comunicación durante el proceso de registro.
Valor por defecto:
"en"
Minimal Body Data
{
"project": "ObjectId('5f8d0a24c6345c001fa9e2b3')",
"projectFlow": "ObjectId('5f8d0a24c6345c001fa9e2b4')",
"email": "user@example.com",
"phone": "1234567890",
"countryCode": "+1"
}
Full Body Data
{
"project": "ObjectId('5f8d0a24c6345c001fa9e2b3')",
"projectFlow": "ObjectId('5f8d0a24c6345c001fa9e2b4')",
"email": "user@example.com",
"phone": "1234567890",
"countryCode": "+1",
"language": "es"
}
Request
curl -X POST https://api.verifik.co/v2/app-registrations \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"project": "5f8d0a24c6345c001fa9e2b3",
"projectFlow": "5f8d0a24c6345c001fa9e2b4",
"email": "user@example.com",
"phone": "1234567890",
"countryCode": "+1",
"language": "es"
}'
Respuesta
La respuesta contendrá información sobre la nueva instancia de App Registration. Los campos importantes incluyen _id: Identificador único de la instancia de registro, status: Estado del proceso de registro. token para verificar el registro.
Ejemplo de Respuesta Exitosa
{
"data": {
"appRegistration": {
"_id": "65772f3b427932d45a3811f9",
"client": "5f8d0a24c6345c001fa9e2b2",
"project": "5f8d0a24c6345c001fa9e2b3",
"projectFlow": "5f8d0a24c6345c001fa9e2b4",
"status": "STARTED",
"email": "user@example.com",
"countryCode": "+1",
"phone": "+123456789",
"language": "es",
"currentStep": 1,
"createdAt": "2023-12-11T15:48:11.640Z",
"updatedAt": "2023-12-11T15:48:11.640Z"
},
"informationValidation": {
"_id": "65772f3b427932d45a3811fa"
},
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
}
Last updated