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 Liveness

GET basePath/api/v1/liveness/event

En este endpoint puede buscar una lista de eventos relacionados con Liveness.

Puede filtrar por varios campos de eventos mediante query params.

Descripción de la Solicitud

Petición

curl -X GET "https://api.sandbox.jaak.ai/api/v1/liveness/event" \
     -H "Accept: application/json" \
     -H "Authorization: Bearer <accessToken>" \
     -G \
     --data-urlencode "params={
         'limit': <int>,
         'page': <int>,
         'action': '<string>',
         'status': '<string>',
         'event-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>",            
  "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., "verify-and-bestframe").
statusEstado de los eventos para filtrar, representado como una cadena de texto (e.g., "success").
event-idIdentificador único del evento, 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 accion disponible en Passwordless: "bestframe-verify-liveness".

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., "bestframe-verify-liveness").
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/v1/liveness/event?limit=10&page=1&action=bestframe-verify-liveness&status=success&event-id=06722190-9de7-4d1b-a9ad-1559a5ab8cb9&min-process-time=100&max-process-time=200&min-created-at=2024-01-19T00%3A00%3A00Z&max-created-at=2024-01-19T00%3A00%3A00Z' \
     --header 'accept: application/json' \
     --header 'Authorization: Bearer <accessToken>' \
{
    "totalDocs": 11,
    "totalPages": 2,
    "docList": [
      {
            "id": "66b2ac8d6dfe7dad6f172e08",
            "createdAt": "2024-08-06T23:06:53.769Z",
            "updatedAt": "0001-01-01T00:00:00Z",
            "eventId": "",
            "request": {
                "id": "d0395fd0-09f4-471d-b89d-01ad44050cdc",
                "ip": "169.254.169.126",
                "method": "post",
                "statusCode": 200,
                "path": "/api/v1/liveness/verify-and-bestframe",
                "meta": {
                    "request": null,
                    "response": null
                }
            },
            "action": "bestframe-verify-liveness",
            "status": "success",
            "message": "",
            "processTime": 4045,
            "flow": null,
            "meta": null
        },
        {...}
    ],
    "limit": 10,
    "page": 1,
    "nextPage": true,
    "prevPage": false
}

Buscar evento por Id

GET basePath/api/v1/liveness/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": {},
            "response": {}
        }
    },
    "action": "<string>",
    "status": "<string>",
    "message": "<string>",
    "processTime": "<int>",
    "flow": [
        {
            "resource": "<string>",
            "status": "<string>",
            "message": "<string>",
            "meta": {
                "time": "<date-time>",
                "processTime": "<int>",
                "extra": {}
            }
        },
        {
            "resource": "<string>",
            "status": "<string>",
            "message": "<string>",
            "meta": {
                "time": "<date-time>",
                "processTime": "<int>",
                "extra": {}
            }
        }
    ],
    "meta": {
        "extra": {
            "company_id": "<string>",
            "product": "<string>",
            "user_id": "<string>"
        }
    }
}

Descripción de los parámetros

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.
statusEstado de la solicitud, representado como una cadena de texto.
messageMensaje asociado con la solicitud, representado como una cadena de texto.
processTimeTiempo de procesamiento en milisegundos, representado como un entero.
flowLista de recursos y estados asociados.
metaMetadatos adicionales.

Descripción del Objeto request

ParámetroDescripción
idIdentificador único de la solicitud, representado como una cadena de texto.
ipDirección IP desde la que se hizo la solicitud, representada como una cadena de texto.
methodMétodo HTTP utilizado, representado como una cadena de texto (e.g., "put").
statusCodeCódigo de estado HTTP de la respuesta, representado como un entero.
pathRuta de la solicitud, representada como una cadena de texto.
metaMetadatos adicionales sobre la solicitud y la respuesta.

Descripción del Objeto flow

ParámetroDescripción
resourceRecurso asociado, representado como una cadena de texto.
statusEstado del recurso, representado como una cadena de texto.
messageMensaje asociado con el recurso, representado como una cadena de texto.
metaMetadatos adicionales sobre el 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 único de la compañía, representado como una cadena de texto.
productNombre del producto, representado como una cadena de texto.
user_idIdentificador único 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": "66b2ac8d6dfe7dad6f172e08",
    "createdAt": "2024-08-06T23:06:53.769Z",
    "updatedAt": "2024-08-06T23:06:53.769Z",
    "eventId": "d0395fd0-09f4-471d-b89d-01ad44050cdc",
    "request": {
        "id": "d0395fd0-09f4-471d-b89d-01ad44050cdc",
        "ip": "169.254.169.126",
        "method": "post",
        "statusCode": 200,
        "path": "/api/v1/liveness/verify-and-bestframe",
        "meta": {
            "request": {
                "video": "https://storage.googleapis.com/dev-nfury-media/74cbbcf5-fa68-43d5-8316-d4d49881522a.media?X-Goog-Algorithm=GOOoog-SignedHeaders=host"
            },
            "response": null
        }
    },
    "action": "bestframe-verify-liveness",
    "status": "success",
    "message": "",
    "processTime": 4045,
    "flow": [
        {
            "resource": "liveness",
            "status": "success",
            "message": "",
            "meta": {
                "time": "2024-08-06T23:06:50.109Z",
                "processTime": 2351.2334,
                "extra": {
                    "evaluation": {
                        "image": "https://storage.googleapis.com/dev-nfury-media/38424757-e8ae-437d-afc1-d14b025569ea.media?X-Goog-Algorithm=GOGoog-SignedHeaders=host",
                        "score": 0.9694316387176514,
                        "score_emet1": 0.00008136124961310998,
                        "score_liveness": 0.9694316387176514,
                        "score_lmet1": 0.9999994039535522,
                        "score_lmet3": 0.9999094605445862
                    },
                    "thresholds": {
                        "score": 0.75,
                        "score_emet1": 0.699999988079071,
                        "score_liveness": 0.75
                    },
                    "validation": {
                        "is_correct": true,
                        "is_real": true
                    }
                }
            }
        }
    ],
    "meta": {
        "extra": {
            "company_id": "<company_id>",
            "product": "liveness",
            "user_id": "<user_id>"
        }
    }
}

Updated about 2 months ago