Detalles de un flujo

Consultar todos los Flujos

GET basePath/api/v1/kyc/session

Este endpoint permite obtener la información general de todos los flujos creados dependiendo los filtros aplicados.

Descripción de la Solicitud

curl -X GET "https://sandbox.api.jaak.ai/api/v1/kyc/session?limit=10&page=1"
-H "Content-Type: application/json" \
-H "Authorization: Bearer accessToken"

Descripción de los parámetros

Parámetro	Descripción
`accessToken`	Token de acceso de KYC.

Query Parameters:

Parameter	Type	Description	Required	Default
`id`	String	The unique identifier for the KYC session.	Yes	N/A
`limit`	Integer	The number of items to return.	No	10
`page`	Integer	The page number to return.	No	1
`min-created-at`	Datetime	The minimum creation date to filter sessions.	No	N/A
`max-created-at`	Datetime	The maximum creation date to filter sessions.	No	N/A

{
"totalDocs": 11,
"totalPages": 2,
"docList": [
{
  "sessionID": "66a96dd6f361c724edcd4040",
  "contactName": "test",
  "verificationType": "",
  "verification": {
    "EMAIL": "",
    "WHATSAPP": "",
    "SMS": "",
    "smsDetail": {
      "status": "",
      "message": ""
    }
  },
  "flowName": "test",
  "startDate": "2024-07-30T22:49:22Z",
  "updateDate": "2024-07-30T22:49:58Z",
  "endDate": "2024-07-30T22:49:58Z",
  "origin": "web",
  "score": 97.92088174819946,
  "status": "PASS",
  "shortKey": "02yXzAo",
  "validation": "AUTOMATIC",
  "flowType": "KYC",
  "rigelUrl": "",
  "location": {
    "city": "",
    "state": "",
    "country": "",
    "latitude": 0,
    "longitude": 0
  }
},
// ... {9}
],
"limit": 10,
"page": 1,
"nextPage": true,
"prevPage": false
}

Ejemplos de Solicitudes

  curl -X GET "https://sandbox.api.jaak.ai/api/v1/kyc/session?limit=10&page=1"
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer accessToken"

{
  "totalDocs": 11,
  "totalPages": 2,
  "docList": [
{
  "sessionID": "66a96dd6f361c724edcd4040",
  "contactName": "test",
  "verificationType": "",
  "verification": {
  "EMAIL": "",
  "WHATSAPP": "",
  "SMS": "",
  "smsDetail": {
  "status": "",
  "message": ""
}
},
  "flowName": "test",
  "startDate": "2024-07-30T22:49:22Z",
  "updateDate": "2024-07-30T22:49:58Z",
  "endDate": "2024-07-30T22:49:58Z",
  "origin": "web",
  "score": 97.92088174819946,
  "status": "PASS",
  "shortKey": "02yXzAo",
  "validation": "AUTOMATIC",
  "flowType": "KYC",
  "rigelUrl": "",
  "location": {
  "city": "",
  "state": "",
  "country": "",
  "latitude": 0,
  "longitude": 0
}
},
  // ... {9}
  ],
  "limit": 10,
  "page": 1,
  "nextPage": true,
  "prevPage": false
}

Consultar Flujo por SessionId

GET basePath/api/v1/kyc/session/[sessionId]

Este endpoint permite obtener la información completa de un flujo en especifico, y los resultados generales y especificos de su flujo.

Descripción de la Solicitud

Petición

curl -X GET "https://sandbox.api.jaak.ai/api/v1/kyc/session/[sessionId]"
-H "Content-Type: application/json" \
-H "Authorization: Bearer <accessToken>"

Parámetro	Descripción
`accessToken`	Token de acceso de KYC.
sessionId	Identificador de la flujo.

Respuesta

{
  "session": {
  "sessionID": "<string>",
  "contactName": "<string>",
  "verificationType": "<string>",
  "verification": {...},
  "flowName": "<string>",
  "startDate": "<datetime>",
  "updateDate": "<datetime>",
  "endDate": "<datetime>",
  "origin": "<string>",
  "score": "<float>",
  "status": "<string>",
  "shortKey": "<string>",
  "validation": "<string>",
  "flowType": "<string>",
  "rigelUrl": "<string>",
  "location": {
  "city": "<string>",
  "state": "<string>",
  "country": "<string>",
  "latitude": "<float>",
  "longitude": "<float>"
}
},
  "summary": {
  "photo": "<string>",
  "totalTime": "<float>",
  "name": "<string>",
  "lastName": "<string>",
  "curp": "<string>",
  "scores": {
  "liveness": "<float>",
  "document": "<float>",
  "oneToOne": "<float>",
  "total": "<float>"
},
  "rigelFullVideo": "<string>"
},
  "flow": [{...}]
}

Descripción de los parámetros

Campo	Descripción
session	Información de sesión.
summary	Resumen de datos.
flow	Flujo de información.

Objeto `session`:

Nombre	Descripción
sessionID	Identificador único para la sesión KYC.
contactName	Nombre del contacto asociado con la sesión.
verificationType	Tipo de verificación utilizada en la sesión.
verification	Detalles de la verificación, incluyendo métodos como EMAIL, WHATSAPP y SMS.
flowName	Nombre del flujo de verificación.
startDate	Fecha y hora de inicio de la sesión.
updateDate	Fecha y hora de la última actualización de la sesión.
endDate	Fecha y hora de finalización de la sesión.
origin	Origen de la solicitud (por ejemplo, web).
score	Puntuación obtenida en la sesión KYC.
status	Estado final de la sesión (por ejemplo, PASS).
shortKey	Clave corta asociada con la sesión.
validation	Método de validación utilizado (por ejemplo, AUTOMATIC).
flowType	Tipo de flujo (por ejemplo, KYC).
rigelUrl	URL asociada con Rigel, si corresponde.
location	Información de ubicación asociada con la sesión.

Objeto `summary`:

Nombre	Descripción
photo	URL de la foto asociada con el resumen.
totalTime	Tiempo total de la sesión.
name	Nombre del individuo asociado con el resumen.
lastName	Apellido del individuo asociado con el resumen.
curp	Clave Única de Registro de Población del individuo.
scores	Puntuaciones obtenidas en las diferentes etapas de la sesión.
rigelFullVideo	URL del video completo asociado con Rigel, si corresponde.

Ejemplos de Solicitudes

    curl -X GET "https://sandbox.api.jaak.ai/api/v1/kyc/session/{sessionId}"
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer accessToken"

{
  "session": {
  "sessionID": "66a96dd6f361c724edcd4040",
  "contactName": "test",
  "verificationType": "",
  "verification": {},
  "flowName": "test",
  "startDate": "2024-07-30T22:49:22Z",
  "updateDate": "2024-07-30T22:49:58Z",
  "endDate": "2024-07-30T22:49:58Z",
  "origin": "web",
  "score": 97.92088174819946,
  "status": "PASS",
  "shortKey": "02yXzAo",
  "validation": "AUTOMATIC",
  "flowType": "KYC",
  "rigelUrl": "",
  "location": {
  "city": "Ciudad de México",
  "state": "CDMX",
  "country": "Mexico",
  "latitude": 19.4328156,
  "longitude": -99.1331764
}
},
  "summary": {
  "photo": "https://storage.googleapis.com/dev-nfury-media/28b86917-f5f0-40ac-95f7-bec\u0026X-Goog-SignedHeaders=host",
  "totalTime": 0.5980833333333333,
  "name": "ALEJANDRO",
  "lastName": "SANTAMARIA CANSECO",
  "curp": "SACA950714HDFNNL05",
  "scores": {
  "liveness": 96.91675901412964,
  "document": 100,
  "oneToOne": 96.84588623046875,
  "total": 97.92088174819946
},
  "rigelFullVideo": ""
},
  "flow": [{}]
}

Iniciar sesión para KYC (Android)

POST basePath/api/v1/kyc/session

Este endpoint regresa el token necesario para mandar en el header 'Autentication' para todas las peticiones del flujo de KYC.

Descripción de la Solicitud

Petición

@POST("api/v1/kyc/session")
suspend fun sessionApi(@Header("Short-Key") shortKey: String,
                    @Header("Origin-Device") originDevice: String): Response<SessionResponse>

Descripción de los parámetros en header

Parámetro	Descripción
Short-Key	Short Key de acceso de KYC.
Origin-Device	Identificador de flujo.

Respuesta

{
"accessToken": "string",
"step": "integer",
"sessionId": "string",
"assets": {
    "document": "null | string",
    "liveness": "null | string"
},
"document": "string"
}

data class SessionResponse(
@SerializedName("accessToken") val accessToken: String,
@SerializedName("step") val step: Int,
@SerializedName("sessionId") val sessionId: String,
@SerializedName("assets") val assets: SessionAssets,
@SerializedName("document") val document: String
)

data class SessionAssets(
@SerializedName("document") val document: String?, 
@SerializedName("liveness") val liveness: String?
)

Descripción de los parámetros

Campo	Descripción
accessToken	Token de acceso en formato de cadena para la autenticación.
step	Número entero que representa el paso actual del proceso.
sessionId	Identificador de sesión en formato de cadena.
assets	Objeto que contiene recursos relacionados, como document y liveness.
document	Código de documento, representado como una cadena

Objeto `assets`:

Nombre	Descripción
document	Proceso de document.
liveness	Proceso de liveness.

Ejemplos de Solicitudes

{}

{
"accessToken": "token",
"step": 0,
"sessionId": "6797fc14dd6e0a73804e1209",
"assets": {
    "document": null,
    "liveness": null
},
"document": "MEX"
}

Finalizar sesión para KYC (Android)

POST basePath/api/v1/kyc/session/finish

Este endpoint permite finalizar un flujo KYC.

Descripción de la Solicitud

Petición

@POST("api/v1/kyc/session/finish")
suspend fun finishApi(@Header("Authorization") auth: String): Response<FinishResponse>

Descripción de los parámetros en header

Parámetro	Descripción
Authorization	Token generado para flujo de KYC.

Respuesta

Aquí solamente se valida que el servicio responda como exitoso (estatus HTTP 200), y con esto finaliza el flujo de KYC

{}

class FinishResponse()

Descripción de los parámetros

Campo	Descripción

Ejemplos de Solicitudes

{}

{}

Consultar todos los Flujos

Descripción de los parámetros

Query Parameters:

Consultar Flujo por SessionId

Petición

Respuesta

Descripción de los parámetros

Objeto session:

Objeto summary:

Iniciar sesión para KYC (Android)

Petición

Descripción de los parámetros en header

Respuesta

Descripción de los parámetros

Objeto assets:

Finalizar sesión para KYC (Android)

Petición

Descripción de los parámetros en header

Respuesta

Descripción de los parámetros

Objeto `session`:

Objeto `summary`:

Objeto `assets`: