Guides
Start typing to search…

Sesiones KYC

Sesión KYC JAAK


1. Creación de una Sesión KYC y Short Key


Existen dos opciones para este paso: crear la Sesión KYC a través de la Plataforma JAAK o mediante llamadas API. La segunda opción se utiliza preferentemente para crear sesiones KYC automatizadas. A continuación, cubriremos ambas opciones.


Crear Sesión KYC mediante Plataforma JAAK

Dentro de la plataforma JAAK, dirígete a KYC -> Sesiones dentro del menú.

Sesiones KYC - Crear nueva Sesión KYC

Da clic en el botón Crear nueva sesión y llena el formulario con los siguientes datos:

  • Nombre del contacto (requerido): El nombre de la persona que realizará la Sesión KYC
  • Nombre del flujo (requerido): Nombre que puedes otorgarle a la Sesión KYC
  • Url de redireccionamiento (opcional): Si deseas redirigir al usuario a una página específica al final de la Sesión KYC.
  • País de documentación (requerido): Debes seleccionar el país del cual vas a aceptar documentación para la Sesión KYC.
  • Tipo de flujo (requerido): El tipo de KYC a realizar, por defecto se usa KYC Tradicional
  • Medio de validación (opcional): Es el método de notificación que prefieres para enviar un enlace a una persona y que pueda iniciar y realizar su Sesión KYC desde la Plataforma KYC.

Una vez llenado el formulario, da clic en Guardar y sucederá lo siguientes:

  • Se enviará una notificación por el medio que hayas elegido en caso de elegir esta opción.
  • Se te mostrará una URL en la pantalla para que puedas iniciar tu Sesión KYC a través de nuestra Plataforma KYC.

El Short Key, son los últimos 7 caracteres de la URL que fue creado para esta Sesión KYC. Guárdalo porque lo necesitarás en el siguiente paso.

Los Short Keys identifican de forma única a una Sesión KYC, suelen estar conformados por 7 caracteres alfanuméricos.


Crear Sesión KYC mediante llamadas APIs

Siempre que realicemos llamadas APIs necesitamos que esas llamadas o peticiones estén autenticadas, para ellos dentro de la Plataforma JAAK tienes la opción de crear API keys que son nuestro método para autenticar llamadas APIs.

Dentro de la Plataforma JAAK, dirígete a Ajustes -> Api keys dentro del menú.

Da clic en el botón Generar nueva API key y llena el formulario con los siguientes datos:

  • Nombre (requerido): Nombre de tu API key, para poder identificar en el futuro.
  • Expira en (requerido): El tiempo de vigencia que quieres que tenga la Api Key

Una vez llenado el formulario, da click en Guardar.

Copia y guarda en un lugar seguro la API key por que no podrás recuperarla en el futuro.

Damos la opción de poder crear API key sin vigencia, para automatizaciones a largo plazo, pero ten en cuenta el riesgo que esto conlleva si llevas a compartirlo.

Ahora que ya tienes una manera de autenticar tus llamadas APIs, vamos a crear una Sesión KYC, para ello realiza una llamada API a la siguiente URL, incluyendo los siguientes datos necesarios para la creación de la Sesión KYC.


URL

POST  https://sandbox.api.jaak.ai/api/v1/kyc/flow

Body:

{
  "name": "Juan Perez Perez",
  "flow": "OnBoarding",
  "redirectUrl": "https://mi-pagina.com",
  "countryDocument": "MEX",
  "flowType": "KYC",
  "verificationType": "whatsapp",
  "verification": {
    "SMS": "",
    "EMAIL": "",
    "WHATSAPP": "+522222222222"
  }
}

  • name (requerido): El nombre de la persona que realizará la Sesión KYC
  • flow (requerido): Nombre que puedes otorgarle a la Sesión KYC
  • redirectUrl (opcional): Si deseas redirigir al usuario a una página específica al final de la Sesión KYC.
  • countryDocument (requerido): Debes seleccionar el país del cual vas a aceptar documentación para la Sesión KYC, se usa la nomenclatura Alpha 3 Code para referirnos al país.
  • flowType (requerido): El tipo de KYC a realizar, por defecto se usa KYC Tradicional.
  • verificationType (opcional): Es el método de notificación que prefieres para enviar un enlace a una persona y que pueda iniciar su Sesión KYC desde la Plataforma KYC, las opciones permitidas son “whatsapp”, “sms”, “email” o “” (vacío, para identificar que no quieres enviar notificación).
  • verification.SMS (opcional): Si en el campo “verificationType” seleccionaste “sms” aca deberás colocar el numero telefónico para enviar la notificación.
  • verification.EMAIL (opcional): Si en el campo “verificationType” seleccionaste “email” aca deberás colocar el correo electrónico para enviar la notificación
  • verification.WHATSAPP (opcional): Si en el campo “verificationType” seleccionaste “whatsapp” aca deberás colocar el numero de teléfono para enviar la notificación

En la configuración de tu compañía, debes seleccionar una lista de países que puedes usar para crear Sesiones KYC, dependiendo de esa configuración en la compañía son las opciones que puedes usar para crear el parametro countryDocument. Para conocer el listado completo de los países soportados, puedes ver acá.


El numero que se envia en los parametros “verification.SMS“ y “verification.WHATSAPP“ deben contener el código del pais, por ejemplo:

  • +52 para México
  • +1 para Estados Unidos

Response:

{  
    "sessionUrl": "https://sandbox.kyc.jaak.ai/session/WIoGa8e"  
}

Una vez realizada la llamada sucederá lo siguientes:

  • Se enviará una notificación por el medio que hayas elegido en caso de ser así.
  • Se responderá con una URL con la que podrás iniciar tu Sesión KYC a través de nuestra Plataforma KYC.

El Short Key, son los últimos 7 caracteres de la URL que fue creado para esta Sesión KYC. Guárdalo porque lo necesitarás en el siguiente paso.

Los Short Keys identifican de forma única a una Sesión KYC, suelen estar conformados por 7 caracteres alfanuméricos.


Implementación de KYC

Existen dos métodos de implementación disponibles, en donde será necesario utilizar el Short Key generado previamente y llevar a cabo una Sesión KYC.


Visualización de resultados de Sesión KYC

Excelente! Si has llegado hasta aquí, ya tienes todo el conocimiento necesario para implementar correctamente un KYC JAAK.

A continuación, te mostraremos cómo visualizar las sesiones realizadas. Esto puede hacerse a través de la Plataforma JAAK o mediante una API.

Plataforma JAAK

Para ver todas las sesiones, ve a KYC -> Sesiones en el menú de la Plataforma JAAK. Puedes hacer clic en cualquier sesión para ver sus detalles.

Sesiones KYC

API

Puedes utilizar la siguiente URL para buscar y listar las sesiones realizadas.

Es necesario autenticar todas las siguientes llamadas API mediante una cabecera denominada "Authorization", cuyo valor debe ser "Bearer [Api-Key]".

Si no posees una API key, te recomendamos leer el siguiente texto.


URL

GET https://sandbox.api.jaak.ai/api/v1/kyc/session?limit=10&page=1

Response

{
  "totalDocs": 2,
  "totalPages": 1,
  "docList": [
    {
    "sessionID": "67a696be0bcec02b88888888",
    "contactName": "test 1",
    "verificationType": "sms",
    "verification": {
      "EMAIL": "",
      "WHATSAPP": "",
      "whatsappDetail": {
        "status": "",
        "message": ""
      },
      "SMS": "+521111111111",
      "smsDetail": {
        "status": "RECEIVED",
        "message": ""
      }
    },
    "flowName": "test 2",
    "startDate": "2025-02-07T23:27:00Z",
    "updateDate": "2025-02-07T23:31:39Z",
    "endDate": "2025-02-07T23:31:39Z",
    "origin": "web",
    "score": 95,
    "status": "PASS",
    "shortKey": "SHRUoNx",
    "validation": "AUTOMATIC",
    "flowType": "KYC",
    "rigelUrl": "",
    "location": {
      "city": "",
      "state": "",
      "country": "",
      "latitude": 0,
      "longitude": 0
    }
  },
  {
    "sessionID": "67a694450bcec04444444444",
    "contactName": "test 2",
    "verificationType": "whatsapp",
    "verification": {
      "EMAIL": "",
      "WHATSAPP": "+5211111111111",
      "whatsappDetail": {
        "status": "SEND",
        "message": ""
      },
      "SMS": "",
      "smsDetail": {
        "status": "",
        "message": ""
      }
    },
    "flowName": "test",
    "startDate": "2025-02-07T23:17:18Z",
    "updateDate": "2025-02-07T23:18:47Z",
    "endDate": "2025-02-07T23:18:47Z",
    "origin": "web",
    "score": 95,
    "status": "PASS",
    "shortKey": "vfc1azK",
    "validation": "AUTOMATIC",
    "flowType": "KYC",
"rigelUrl": "",
    "location": {
      "city": "",
      "state": "",
      "country": "",
      "latitude": 0,
      "longitude": 0
    }
  }
],
  "limit": 5,
  "page": 1,
  "nextPage": false,
  "prevPage": false
}

Sin embargo, si necesitas encontrar una Sesión KYC específica, puedes buscarla usando su Short Key. Solo necesitas especificar el Short Key en el Query Params como se muestra a continuación.

URL

GET https://sandbox.api.jaak.ai/api/v1/kyc/session?limit=10&page=1&shortKey=vfc1azK

Response

{
  "totalDocs": 1,
  "totalPages": 1,
  "docList": [
    {
      "sessionID": "67a694450bcec02222222222",
      "contactName": "test",
      "verificationType": "whatsapp",
      "verification": {
        "EMAIL": "",
        "WHATSAPP": "+521111111111",
        "whatsappDetail": {
          "status": "SEND",
          "message": ""
        },
        "SMS": "",
        "smsDetail": {
          "status": "",
          "message": ""
        }
      },
      "flowName": "test",
      "startDate": "2025-02-07T23:17:18Z",
      "updateDate": "2025-02-07T23:18:47Z",
      "endDate": "2025-02-07T23:18:47Z",
      "origin": "web",
      "score": 95,
      "status": "PASS",
      "shortKey": "vfc1azK",
      "validation": "AUTOMATIC",
      "flowType": "KYC",
      "rigelUrl": "",
      "location": {
        "city": "",
        "state": "",
        "country": "",
        "latitude": 0,
        "longitude": 0
      }
    }
  ],
  "limit": 10,
  "page": 1,
  "nextPage": false,
  "prevPage": false
}

En ambos casos, obtendrás una lista de resultados con información preliminar de las sesiones KYC. Posteriormente, para obtener la información completa de una Sesión KYC, será necesario realizar la siguiente llamada.

URL

GET https://sandbox.api.jaak.ai/api/v1/kyc/session/<sessionID>

El parámetro <sessionID> en la URL de arriba, corresponde con el parámetro sessionID de una Sesión KYC. Este parámetro sessionID se puede encontrar dentro de las propiedades preliminares al listar las sesiones KYC.


¡Felicitaciones!

Has completado esta guía. Ahora deberías comprender claramente cómo crear e implementar sesiones KYC JAAK. Si tienes alguna pregunta, no dudes en contactar a [email protected].

Updated about 19 hours ago