Guides
Start typing to search…

Events

Para usar este producto, necesitas:

  • Necesitas una clave API válida de una empresa activa y configurarla como Bearer Token en el encabezado de tu solicitud. Para más información sobre el uso del Bearer Token consulta aquí.

Todos los eventos One to One

GET basePath/api/v1/oto/event

En este endpoint puede buscar una lista de eventos relacionados con One to One. Puede filtrar por varios campos de eventos, estos campos se enumeran en la parte inferior como query params.

Descripción de la Solicitud

Petición

curl -X GET "https://api.sandbox.jaak.ai/api/v1/oto/event" \
     -H "Accept: application/json" \
     -H "Authorization: Bearer <accessToken>" \
     -G \
     --data-urlencode "params={
         'limit': <int>,
         'page': <int>,
         'action': '<string>',
         'status': '<string>',
         'event-id': '<uuid>',
         'request-id': '<uuid>',
         'min-process-time': <int>,
         'max-process-time': <int>,
         'min-created-at': '<date-time>',
         'max-created-at': '<date-time>'
     }"

{
  "limit": "<int>",                
  "page": "<int>",                
  "action": "<string>",            
  "status": "<string>",          
  "event-id": "<uuid>",            
  "request-id": "<uuid>",            
  "min-process-time": "<int>",    
  "max-process-time": "<int>",  
  "min-created-at": "<date-time>", 
  "max-created-at": "<date-time>"  
}

Descripción de los parámetros

ParámetroDescripción
limitNúmero de resultados a devolver, representado como un entero.
pageNúmero de página para la paginación, representado como un entero.
actionAcción para filtrar los eventos, representado como una cadena de texto (e.g., "v2-verify-oto").
statusEstado de los eventos para filtrar, representado como una cadena de texto (e.g., "success").
event-idIdentificador único del evento, representado como un UUID.
request-idIdentificador único de la petición, representado como un UUID.
min-process-timeTiempo mínimo de procesamiento en milisegundos, representado como un entero.
max-process-timeTiempo máximo de procesamiento en milisegundos, representado como un entero.
min-created-atFecha y hora de creación más temprana en formato ISO 8601, representada como una cadena de texto.
max-created-atFecha y hora de creación más reciente en formato ISO 8601, representada como una cadena de texto.

📝 Nota: Las acciones disponibles en One to One son: "v2-verify-oto", "v11-verify-oto" y "v1-verify-oto"


Respuesta

{
    "totalDocs": "<int>",
    "totalPages": "<int>",
    "docList": [
        {
            "id": "<string>",
            "createdAt": "<date-time>",
            "updatedAt": "<date-time>",
            "eventId": "<string>",
            "request": {
                "id": "<string>",
                "ip": "<string>",
                "method": "<string>",
                "statusCode": "<int>",
                "path": "<string>",
                "meta": {
                    "request": {},
                    "response": {}
                }
            },
            "action": "<string>",
            "status": "<string>",
            "message": "<string>",
            "processTime": "<int>",
            "flow": {},
            "meta": {}
        },
        {...}
    ],
    "limit": "<int>",
    "page": "<int>",
    "nextPage": "<boolean>",
    "prevPage": "<boolean>"
}

Descripción de los parámetros

ParámetroDescripción
totalDocsNúmero total de documentos, representado como un entero.
totalPagesNúmero total de páginas, representado como un entero.
docListLista de documentos .
limitNúmero de resultados por página, representado como un entero.
pageNúmero de página actual, representado como un entero.
nextPageIndica si hay una página siguiente, representado como un booleano.
prevPageIndica si hay una página previa, representado como un booleano.

Descripción de docList

ParámetroDescripción
idIdentificador único del documento, representado como una cadena de texto.
createdAtFecha y hora en que se creó el documento, representada en formato ISO 8601.
updatedAtFecha y hora en que se actualizó el documento, representada en formato ISO 8601.
eventIdIdentificador del evento asociado, representado como una cadena de texto.
requestInformación sobre la solicitud .
actionAcción realizada, representada como una cadena de texto (e.g., "v2-verify-oto").
statusEstado de la solicitud, representado como una cadena de texto (e.g., "success").
messageMensaje asociado con la solicitud, representado como una cadena de texto.
processTimeTiempo de procesamiento en milisegundos, representado como un entero.
flowFlujo asociado al documento, puede ser nulo.
metaMetadatos adicionales, puede ser nulo.


Ejemplos de Solicitudes
curl --request GET \
     --url 'https://api.sandbox.jaak.ai/api/v2/oto/event?limit=10&page=1&action=v2-verify-oto&status=success&event-id=66b3c28e08e20c88364bd5cb&request-id=f9a12e86-a6ae-4060-89d6-04946e034436&min-process-time=100&max-process-time=200&min-created-at=2022-01-19T00%3A00%3A00Z&max-created-at=2022-01-19T00%3A00%3A00Z' \
     --header 'accept: application/json'
     --header 'Authorization: Bearer <accessToken>' \
{
    "totalDocs": 11,
    "totalPages": 2,
    "docList": [
        {
            "id": "66b3c28e08e20c88364bd5cb",
            "createdAt": "2024-08-06T21:48:59.978Z",
            "updatedAt": "0001-01-01T00:00:00Z",
            "eventId": "",
            "request": {
                "id": "f9a12e86-a6ae-4060-89d6-04946e034436",
                "ip": "169.254.169.126",
                "method": "post",
                "statusCode": 200,
                "path": "/api/v2/oto/verify",
                "meta": {
                    "request": null,
                    "response": null
                }
            },
            "action": "v2-verify-oto",
            "status": "success",
            "message": "",
            "processTime": 969,
            "flow": null,
            "meta": null
        },
        {...}
    ],
    "limit": 10,
    "page": 1,
    "nextPage": true,
    "prevPage": false
}

Buscar evento por Id

GET basePath/api/v1/passwordless/event/[id]

En este endpoint puede buscar un evento por su ID.

Descripción de la Solicitud

Petición

curl -X GET "https://api.sandbox.jaak.ai/api/v1/liveness/event/[id]" \
     -H "Accept: application/json" \
     -H "Authorization: Bearer <accessToken>" \
{
  "id": "<uuid>",                
}

Descripción de los parámetros

ParámetroDescripción
idIdentificador único del evento, representado como un UUID.

Respuesta

{
    "id": "<string>",
    "createdAt": "<date-time>",
    "updatedAt": "<date-time>",
    "eventId": "<string>",
    "request": {
        "id": "<string>",
        "ip": "<string>",
        "method": "<string>",
        "statusCode": "<int>",
        "path": "<string>",
        "meta": {
            "request": {
                "image1": "<string>",
                "image2": "<string>"
            },
            "response": {}
        }
    },
    "action": "<string>",
    "status": "<string>",
    "message": "<string>",
    "processTime": "<int>",
    "flow": [
        {
            "resource": "<string>",
            "status": "<string>",
            "message": "<string>",
            "meta": {
                "time": "<date-time>",
                "processTime": "<float>",
                "extra": {}
            }
        },
        {...}
    ],
    "meta": {
        "extra": {
            "company_id": "<string>",
            "distance": "<float>",
            "isSamePerson": "<boolean>",
            "product": "<string>",
            "score": "<int>",
            "user_id": "<string>"
        }
    }
}

Descripción de los parámetros

ParámetroDescripción
idIdentificador único del evento, representado como una cadena de texto.
createdAtFecha y hora de creación del evento en formato ISO 8601.
updatedAtFecha y hora de la última actualización del evento en formato ISO 8601.
eventIdIdentificador del evento asociado, representado como una cadena de texto.
requestObjeto que contiene la información de la petición.
actionAcción realizada, representada como una cadena de texto.
statusEstado de la acción, representado como una cadena de texto.
messageMensaje asociado a la acción, representado como una cadena de texto.
processTimeTiempo de procesamiento en milisegundos, representado como un número entero.
flowLista de objetos que representan el flujo de procesamiento. Cada objeto de la lista
metaMetadatos adicionales del evento.

Descripción de los parámetros del objeto request

ParámetroDescripción
idIdentificador único de la petición, representado como una cadena de texto.
ipDirección IP desde donde se realizó la petición, representada como una cadena de texto.
methodMétodo HTTP utilizado en la petición, representado como una cadena de texto.
statusCodeCódigo de estado HTTP de la respuesta, representado como un número entero.
pathRuta de la API solicitada, representada como una cadena de texto.
metaMetadatos adicionales de la petición.

Descripción de los parámetros del objeto flow

ParámetroDescripción
resourceRecurso involucrado en el flujo, representado como una cadena de texto.
statusEstado del recurso en el flujo, representado como una cadena de texto.
messageMensaje asociado al recurso en el flujo, representado como una cadena de texto.
metaMetadatos adicionales del recurso.

Descripción de los parámetros del objeto meta en flow

ParámetroDescripción
timeFecha y hora del evento del recurso en formato ISO 8601.
processTimeTiempo de procesamiento del recurso en milisegundos, representado como un número decimal.
extraInformación adicional del recurso. Representado como un objeto o nulo.

Descripción de los parámetros del objeto meta

ParámetroDescripción
company_idIdentificador de la compañía, representado como una cadena de texto.
distanceDistancia calculada, representada como un número decimal.
isSamePersonIndicador de si es la misma persona, representado como un valor booleano.
productProducto asociado, representado como una cadena de texto.
scorePuntaje asociado, representado como un número entero.
user_idIdentificador del usuario, representado como una cadena de texto.

Ejemplos de Solicitudes
curl --request GET \
     --url 'https://api.sandbox.jaak.ai/api/v1/passwordless/event/66ad6fec2314357ce103e2a7' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer <accessToken>' \
{
    "id": "66b3c28e08e20c88364bd5cb",
    "createdAt": "2024-08-07T18:53:02.147Z",
    "updatedAt": "2024-08-07T18:53:02.147Z",
    "eventId": "f9a12e86-a6ae-4060-89d6-04946e034436",
    "request": {
        "id": "f9a12e86-a6ae-4060-89d6-04946e034436",
        "ip": "169.254.169.126",
        "method": "post",
        "statusCode": 200,
        "path": "/api/v2/oto/verify",
        "meta": {
            "request": {
                "image1": "https://storage.googleapis.com/dev-nfury-media/97399d9b-52e3-4a51-a506-f2e87e4860eb.media?X-Goog-Algorithm=GGoog-SignedHeaders=host",
                "image2": "https://storage.googleapis.com/dev-nfury-media/e07db122-2338-4dd8-8c1c-39e1a128fbf4.media?X-Goog-Algorithm=Goog-SignedHeaders=host"
            },
            "response": null
        }
    },
    "action": "v2-verify-oto",
    "status": "success",
    "message": "",
    "processTime": 934,
    "flow": [
        {
            "resource": "face-accessories",
            "status": "success",
            "message": "",
            "meta": {
                "time": "2024-08-07T18:53:01.768Z",
                "processTime": 129.34709,
                "extra": {
                    "evaluation": {
                        "image1": {
                            "glass": false,
                            "hat": false,
                            "mask": false,
                            "sunGlass": false
                        },
                        "image2": {
                            "glass": false,
                            "hat": false,
                            "mask": false,
                            "sunGlass": false
                        }
                    }
                }
            }
        },
        {
            "resource": "image-quality",
            "status": "rejected",
            "message": "Image1: rejected",
            "meta": {
                "time": "2024-08-07T18:53:01.708Z",
                "processTime": 27,
                "extra": {
                    "evaluation": {
                        "image1": {
                            "blur": 0.4590163826942444,
                            "brightness": 2,
                            "height": 225,
                            "horizontal_rotation": 56.3636360168457,
                            "number_faces": 1,
                            "size_face": 31,
                            "vertical_rotation": 50.96154022216797,
                            "width": 225
                        },
                        "image2": {
                            "blur": 0.4590163826942444,
                            "brightness": 2,
                            "height": 225,
                            "horizontal_rotation": 56.3636360168457,
                            "number_faces": 1,
                            "size_face": 31,
                            "vertical_rotation": 50.96154022216797,
                            "width": 225
                        }
                    },
                    "thresholds": {
                        "brightness": 2,
                        "max_blur": 0.7099999785423279,
                        "max_horizontal_rotation": 60,
                        "max_vertical_rotation": 55,
                        "min_height": 400,
                        "min_horizontal_rotation": 40,
                        "min_size_face": 25,
                        "min_vertical_rotation": 45,
                        "min_width": 400,
                        "number_faces": 1
                    },
                    "validation": {
                        "image1": {
                            "is_correct_blur": true,
                            "is_correct_brightness": true,
                            "is_correct_height": false,
                            "is_correct_horizontal_rotation": true,
                            "is_correct_number_faces": true,
                            "is_correct_resolution": false,
                            "is_correct_rotation": true,
                            "is_correct_size_face": true,
                            "is_correct_vertical_rotation": true,
                            "is_correct_width": false
                        },
                        "image2": {
                            "is_correct_blur": true,
                            "is_correct_brightness": true,
                            "is_correct_height": false,
                            "is_correct_horizontal_rotation": true,
                            "is_correct_number_faces": true,
                            "is_correct_resolution": false,
                            "is_correct_rotation": true,
                            "is_correct_size_face": true,
                            "is_correct_vertical_rotation": true,
                            "is_correct_width": false
                        }
                    }
                }
            }
        },
        {
            "resource": "one-to-one",
            "status": "success",
            "message": "",
            "meta": {
                "time": "2024-08-07T18:53:01.708Z",
                "processTime": 430.61,
                "extra": {
                    "evaluation": {
                        "distance": 1,
                        "score": 100
                    },
                    "thresholds": {
                        "distance": 0.4,
                        "score": 96.1
                    },
                    "validation": {
                        "is_same_person": true
                    }
                }
            }
        }
    ],
    "meta": {
        "extra": {
            "company_id": "65b04320d7f4fa9e6cdbf909",
            "distance": 1,
            "isSamePerson": true,
            "product": "oto",
            "score": 100,
            "user_id": "664e211342716d2dafa2b072"
        }
    }
}

Updated about 2 months ago