Resultados de Sesiones KYC

A continuación, te mostramos cómo visualizar las sesiones KYC realizadas mediante 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].