Create an app registration (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:

Name

Value

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"
}'

const axios = require('axios');

const data = {
  project: "5f8d0a24c6345c001fa9e2b3",
  projectFlow: "5f8d0a24c6345c001fa9e2b4",
  email: "user@example.com",
  phone: "1234567890",
  countryCode: "+1",
  version: 2,
  language: "es"
};

axios.post('https://api.verifik.co/v2/app-registrations', data, {
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error(error.response ? error.response.data : error.message);
});

import android.os.AsyncTask
import java.io.OutputStream
import java.net.HttpURLConnection
import java.net.URL

fun createAppRegistration() {
    val url = URL("https://api.verifik.co/v2/app-registrations")
    val jsonBody = """
        {
          "project": "5f8d0a24c6345c001fa9e2b3",
          "projectFlow": "5f8d0a24c6345c001fa9e2b4",
          "email": "user@example.com",
          "phone": "1234567890",
          "countryCode": "+1",
          "language": "es"
        }
    """.trimIndent()

    AsyncTask.execute {
        with(url.openConnection() as HttpURLConnection) {
            requestMethod = "POST"
            setRequestProperty("Authorization", "Bearer YOUR_ACCESS_TOKEN")
            setRequestProperty("Content-Type", "application/json")
            doOutput = true

            // Write JSON body to the request
            outputStream.use { os: OutputStream ->
                val input = jsonBody.toByteArray(Charsets.UTF_8)
                os.write(input, 0, input.size)
            }

            // Read the response
            val responseCode = responseCode
            if (responseCode == HttpURLConnection.HTTP_OK) {
                inputStream.bufferedReader().use {
                    val response = it.readText()
                    println("Response: $response")
                }
            } else {
                println("Request failed with code: $responseCode")
            }
        }
    }
}

import Foundation

func createAppRegistration() {
    let url = URL(string: "https://api.verifik.co/v2/app-registrations")!
    var request = URLRequest(url: url)
    request.httpMethod = "POST"
    request.setValue("Bearer YOUR_ACCESS_TOKEN", forHTTPHeaderField: "Authorization")
    request.setValue("application/json", forHTTPHeaderField: "Content-Type")

    // JSON body
    let jsonBody: [String: Any] = [
        "project": "5f8d0a24c6345c001fa9e2b3",
        "projectFlow": "5f8d0a24c6345c001fa9e2b4",
        "email": "user@example.com",
        "phone": "1234567890",
        "countryCode": "+1",
        "language": "es"
    ]

    // Convert JSON to Data
    request.httpBody = try? JSONSerialization.data(withJSONObject: jsonBody, options: [])

    // Send request
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
        if let error = error {
            print("Request error:", error)
            return
        }

        if let data = data, let responseString = String(data: data, encoding: .utf8) {
            print("Response data:", responseString)
        } else {
            print("Request failed with response: \(String(describing: response))")
        }
    }
    task.resume()
}

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..."
  }
}

{
  "code": "PreconditionFailed",
  "message": "email domain not allowed"
}

{
  "code": "Conflict",
  "message": "email_is_registered_already"
}

{
  "code": "MissingParameter",
  "message": "missing project"
}

{
  "code": "MissingParameter",
  "message": "email domain not allowed"
}

{
  "code": "MissingParameter",
  "message": "missing countryCode"
}

PreviousThe AppRegistration object (Registrar objetos en la app)NextSync app registration status (Sincronizar el estado de registro en la app)

Last updated 4 days ago

{ "project": "ObjectId('5f8d0a24c6345c001fa9e2b3')", "projectFlow": "ObjectId('5f8d0a24c6345c001fa9e2b4')", "email": "user@example.com", "phone": "1234567890", "countryCode": "+1", "language": "es" }

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" }'

import android.os.AsyncTask import java.io.OutputStream import java.net.HttpURLConnection import java.net.URL fun createAppRegistration() { val url = URL("https://api.verifik.co/v2/app-registrations") val jsonBody = """ { "project": "5f8d0a24c6345c001fa9e2b3", "projectFlow": "5f8d0a24c6345c001fa9e2b4", "email": "user@example.com", "phone": "1234567890", "countryCode": "+1", "language": "es" } """.trimIndent() AsyncTask.execute { with(url.openConnection() as HttpURLConnection) { requestMethod = "POST" setRequestProperty("Authorization", "Bearer YOUR_ACCESS_TOKEN") setRequestProperty("Content-Type", "application/json") doOutput = true // Write JSON body to the request outputStream.use { os: OutputStream -> val input = jsonBody.toByteArray(Charsets.UTF_8) os.write(input, 0, input.size) } // Read the response val responseCode = responseCode if (responseCode == HttpURLConnection.HTTP_OK) { inputStream.bufferedReader().use { val response = it.readText() println("Response: $response") } } else { println("Request failed with code: $responseCode") } } } }

import Foundation func createAppRegistration() { let url = URL(string: "https://api.verifik.co/v2/app-registrations")! var request = URLRequest(url: url) request.httpMethod = "POST" request.setValue("Bearer YOUR_ACCESS_TOKEN", forHTTPHeaderField: "Authorization") request.setValue("application/json", forHTTPHeaderField: "Content-Type") // JSON body let jsonBody: [String: Any] = [ "project": "5f8d0a24c6345c001fa9e2b3", "projectFlow": "5f8d0a24c6345c001fa9e2b4", "email": "user@example.com", "phone": "1234567890", "countryCode": "+1", "language": "es" ] // Convert JSON to Data request.httpBody = try? JSONSerialization.data(withJSONObject: jsonBody, options: []) // Send request let task = URLSession.shared.dataTask(with: request) { data, response, error in if let error = error { print("Request error:", error) return } if let data = data, let responseString = String(data: data, encoding: .utf8) { print("Response data:", responseString) } else { print("Request failed with response: \(String(describing: response))") } } task.resume() }

{ "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..." } }

{ "code": "MissingParameter", "message": "missing project" } { "code": "MissingParameter", "message": "email domain not allowed" } { "code": "MissingParameter", "message": "missing countryCode" }