Events

Para usar este producto, 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 Passwordless

GET basePath/api/v1/passwordless/event

En este endpoint puede buscar una lista de eventos relacionados con passwordless. 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/passwordless/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ámetro	Descripción
`limit`	Número de resultados a devolver, representado como un entero.
`page`	Número de página para la paginación, representado como un entero.
`action`	Acción para filtrar los eventos, representado como una cadena de texto (e.g., "update-client-passwordless").
`status`	Estado de los eventos para filtrar, representado como una cadena de texto (e.g., "success").
`event-id`	Identificador único del evento, representado como un UUID.
`min-process-time`	Tiempo mínimo de procesamiento en milisegundos, representado como un entero.
`max-process-time`	Tiempo máximo de procesamiento en milisegundos, representado como un entero.
`min-created-at`	Fecha y hora de creación más temprana en formato ISO 8601, representada como una cadena de texto.
`max-created-at`	Fecha y hora de creación más reciente en formato ISO 8601, representada como una cadena de texto.

📝 Nota: Las acciones disponibles en Passwordless son: "update-client", "video-verify-client" , "facial-client" y "video-enroll-client"

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ámetro	Descripción
`totalDocs`	Número total de documentos, representado como un entero.
`totalPages`	Número total de páginas, representado como un entero.
`docList`	Lista de documentos .
`limit`	Número de resultados por página, representado como un entero.
`page`	Número de página actual, representado como un entero.
`nextPage`	Indica si hay una página siguiente, representado como un booleano.
`prevPage`	Indica si hay una página previa, representado como un booleano.

Descripción de `docList`

Parámetro	Descripción
`id`	Identificador único del documento, representado como una cadena de texto.
`createdAt`	Fecha y hora en que se creó el documento, representada en formato ISO 8601.
`updatedAt`	Fecha y hora en que se actualizó el documento, representada en formato ISO 8601.
`eventId`	Identificador del evento asociado, representado como una cadena de texto.
`request`	Información sobre la solicitud .
`action`	Acción realizada, representada como una cadena de texto (e.g., "update-client-passwordless").
`status`	Estado de la solicitud, representado como una cadena de texto (e.g., "success").
`message`	Mensaje asociado con la solicitud, representado como una cadena de texto.
`processTime`	Tiempo de procesamiento en milisegundos, representado como un entero.
`flow`	Flujo asociado al documento, puede ser nulo.
`meta`	Metadatos adicionales, puede ser nulo.

Ejemplos de Solicitudes

curl --request GET \
--url 'https://api.sandbox.jaak.ai/api/v1/passwordless/event?limit=10&page=1&action=update-client-passwordless&status=success&event-id=06722190-9de7-4d1b-a9ad-1559a5ab8cb9&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": "66ad6fec2314357ce103e2a7",
  "createdAt": "2024-08-02T23:46:52.963Z",
  "updatedAt": "0001-01-01T00:00:00Z",
  "eventId": "",
  "request": {
  "id": "5e1dc1a5-095a-4eb2-9a32-d5371a4a718a",
  "ip": "169.254.169.126",
  "method": "put",
  "statusCode": 200,
  "path": "/api/v1/passwordless/client/66ad6fbe2314357ce103e2a2",
  "meta": {
  "request": null,
  "response": null
}
},
  "action": "update-client-passwordless",
  "status": "success",
  "message": "",
  "processTime": 628,
  "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/passwordless/event/[id]" \
-H "Accept: application/json" \
-H "Authorization: Bearer <accessToken>" \

{
  "id": "<uuid>",
}

Descripción de los parámetros

Parámetro	Descripción
`id`	Identificador ú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": {...}
}
},
{...}
  ],
  "meta": {
  "extra": {
  "company_id": "<string>",
  "product": "<string>",
  "user_id": "<string>"
}
}
}

Descripción de los parámetros

Parámetro	Descripción
`id`	Identificador único del documento, representado como una cadena de texto.
`createdAt`	Fecha y hora en que se creó el documento, representada en formato ISO 8601.
`updatedAt`	Fecha y hora en que se actualizó el documento, representada en formato ISO 8601.
`eventId`	Identificador del evento asociado, representado como una cadena de texto.
`request`	Información sobre la solicitud.
`action`	Acción realizada, representada como una cadena de texto.
`status`	Estado de la solicitud, representado como una cadena de texto.
`message`	Mensaje asociado con la solicitud, representado como una cadena de texto.
`processTime`	Tiempo de procesamiento en milisegundos, representado como un entero.
`flow`	Lista de recursos y estados asociados.
`meta`	Metadatos adicionales.

Descripción del Objeto `request`

Parámetro	Descripción
`id`	Identificador único de la solicitud, representado como una cadena de texto.
`ip`	Dirección IP desde la que se hizo la solicitud, representada como una cadena de texto.
`method`	Método HTTP utilizado, representado como una cadena de texto (e.g., "put").
`statusCode`	Código de estado HTTP de la respuesta, representado como un entero.
`path`	Ruta de la solicitud, representada como una cadena de texto.
`meta`	Metadatos adicionales sobre la solicitud y la respuesta.

Descripción del Objeto `flow`

Parámetro	Descripción
`resource`	Recurso asociado, representado como una cadena de texto.
`status`	Estado del recurso, representado como una cadena de texto.
`message`	Mensaje asociado con el recurso, representado como una cadena de texto.
`meta`	Metadatos adicionales sobre el recurso .

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

Parámetro	Descripción
time	Fecha y hora del evento del recurso en formato ISO 8601.
processTime	Tiempo de procesamiento del recurso en milisegundos, representado como un número decimal.
extra	Información adicional del recurso. Representado como un objeto o nulo.

Descripción de los parámetros del objeto `meta`

Parámetro	Descripción
client_id	Identificador único del cliente, representado como una cadena de texto.
company_id	Identificador único de la compañía, representado como una cadena de texto.
product	Nombre del producto, representado como una cadena de texto.
user_id	Identificador ú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/66ad6fd22314357ce103e2a4' \
--header 'accept: application/json' \
--header 'Authorization: Bearer <accessToken>' \

{
  "id": "66ad6fd22314357ce103e2a4",
  "createdAt": "2024-08-02T23:46:26.274Z",
  "updatedAt": "2024-08-02T23:46:26.274Z",
  "eventId": "6f87dc91-97c4-4344-b4b3-db35924ce8e7",
  "request": {
  "id": "6f87dc91-97c4-4344-b4b3-db35924ce8e7",
  "ip": "169.254.169.126",
  "method": "post",
  "statusCode": 200,
  "path": "/api/v1/passwordless/client/verify",
  "meta": {
  "request": {
  "video": "https://storage.googleapis.com/dev-nfury-media/5e226fdc-ca21-4040-92e3-47f9acfae0b9.media?X-Goog-Algorithm=GOOog-SignedHeaders=host"
},
  "response": null
}
},
  "action": "video-verify-client-passwordless",
  "status": "success",
  "message": "",
  "processTime": 3971,
  "flow": [
{
  "resource": "liveness",
  "status": "success",
  "message": "",
  "meta": {
  "time": "2024-08-02T23:46:23.655Z",
  "processTime": 1464.7775,
  "extra": {
  "evaluation": {
  "image": "https://storage.googleapis.com/dev-nfury-media/c4a350f0-3642-4113-b903-9bd69ad523ca.media?X-Goog-Algorithm=GOOoog-SignedHeaders=host",
  "score": 0.95212721824646,
  "score_emet1": 0.00028826063498854637,
  "score_liveness": 0.95212721824646,
  "score_lmet1": 0.9999745488166809,
  "score_lmet3": 0.9922351241111755
},
  "thresholds": {
  "score": 0.75,
  "score_emet1": 0.699999988079071,
  "score_liveness": 0.75
},
  "validation": {
  "is_correct": true,
  "is_real": true
}
}
}
},
{
  "resource": "image-quality",
  "status": "rejected",
  "message": "Image1: rejected",
  "meta": {
  "time": "2024-08-02T23:46:25.736Z",
  "processTime": 94,
  "extra": {
  "evaluation": {
  "image1": {
  "blur": 0.7017543911933899,
  "brightness": 1,
  "height": 720,
  "horizontal_rotation": 52.47524642944336,
  "number_faces": 1,
  "size_face": 15,
  "vertical_rotation": 57.60869598388672,
  "width": 1280
}
},
  "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": false,
  "is_correct_height": true,
  "is_correct_horizontal_rotation": true,
  "is_correct_number_faces": true,
  "is_correct_resolution": true,
  "is_correct_rotation": false,
  "is_correct_size_face": false,
  "is_correct_vertical_rotation": false,
  "is_correct_width": true
}
}
}
}
},
{
  "resource": "face-accessories",
  "status": "success",
  "message": "",
  "meta": {
  "time": "2024-08-02T23:46:22.601Z",
  "processTime": 786.84546,
  "extra": {
  "evaluation": {
  "evaluation": {
  "glass": false,
  "hat": false,
  "mask": false,
  "sunGlass": false
}
}
}
}
},
{
  "resource": "arcface",
  "status": "success",
  "message": "",
  "meta": {
  "time": "2024-08-02T23:46:25.858Z",
  "processTime": 388,
  "extra": null
}
},
{
  "resource": "mintaka",
  "status": "success",
  "message": "",
  "meta": {
  "time": "2024-08-02T23:46:26.247Z",
  "processTime": 17,
  "extra": null
}
}
  ],
  "meta": {
  "extra": {
  "client_id": "<client_id>",
  "company_id": "<company_id>",
  "product": "passwordless",
  "user_id": "<user_id>"
}
}
}

Todos los eventos Passwordless

Petición

Descripción de los parámetros

Respuesta

Descripción de los parámetros

Descripción de docList

Buscar evento por Id

Petición

Descripción de los parámetros

Respuesta

Descripción de los parámetros

Descripción del Objeto request

Descripción del Objeto flow

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

Descripción de los parámetros del objeto meta

Descripción de `docList`

Descripción del Objeto `request`

Descripción del Objeto `flow`

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

Descripción de los parámetros del objeto `meta`