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 Document

GET basePath/api/v2/document/event

En este endpoint puede buscar una lista de eventos relacionados con Document. 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://sandbox.api.jaak.ai/api/v2/document/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`
`page`
`action`
"front-extract-document").
`status`
`event-id`
`min-process-time`
`max-process-time`
`min-created-at`
texto.
`max-created-at`
texto.

📝 Nota: Las acciones disponibles en Document son: "front-extract-document", "front-verify-document" y "back-extract-document".

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 número entero.
totalPages	Número total de páginas, representado como un número entero.
docList	Lista de documentos, cada uno representado como un objeto.
limit	Límite de documentos por página, representado como un número entero.
page	Número de la página actual, representado como un número entero.
nextPage	Indicador de si hay una página siguiente, representado como un valor booleano.
prevPage	Indicador de si hay una página anterior, representado como un valor booleano.

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

Parámetro	Descripción
id	Identificador único del documento, representado como una cadena de texto.
createdAt	Fecha y hora de creación del documento en formato ISO 8601.
updatedAt	Fecha y hora de la última actualización del documento en formato ISO 8601.
eventId	Identificador del evento asociado, representado como una cadena de texto.
request	Objeto que contiene la información de la petición.
action	Acción realizada, representada como una cadena de texto.
status	Estado de la acción, representado como una cadena de texto.
message	Mensaje asociado a la acción, representado como una cadena de texto.
processTime	Tiempo de procesamiento en milisegundos, representado como un número entero.
flow	Lista de objetos que representan el flujo de procesamiento. Representado como un objeto o nulo.
meta	Metadatos adicionales del documento. Representado como un objeto o nulo.

Ejemplos de Solicitudes

curl --request GET \
--url 'https://sandbox.api.jaak.ai/api/v2/document/event?limit=10&page=1&action=front-extract-document&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": "66b29aff6dfe7dad6f172dd6",
  "createdAt": "2024-08-06T21:51:59.039Z",
  "updatedAt": "0001-01-01T00:00:00Z",
  "eventId": "",
  "request": {
  "id": "66b29a5a6dfe7dad6f172dd2",
  "ip": "169.254.169.126",
  "method": "post",
  "statusCode": 200,
  "path": "/api/v2/document/extract",
  "meta": {
  "request": null,
  "response": null
}
},
  "action": "front-extract-document",
  "status": "success",
  "message": "",
  "processTime": 2584,
  "flow": null,
  "meta": null
},
  ],
  "limit": 10,
  "page": 1,
  "nextPage": true,
  "prevPage": false
}

Buscar evento por Id

GET basePath/api/v2/document/event/id}

En este endpoint puede buscar un evento por su ID.

Descripción de la Solicitud

Petición

curl -X GET "https://sandbox.api.jaak.ai/api/v2/document/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": {
  "country": "<string>",
  "document": "<string>",
  "hasBackSide": "<boolean>",
  "includeOCR": "<boolean>",
  "side": "<string>",
  "type": "<string>"
},
  "response": null
}
},
  "action": "<string>",
  "status": "<string>",
  "message": "<string>",
  "processTime": "<int>",
  "flow": [
{
  "resource": "<string>",
  "status": "<string>",
  "message": "<string>",
  "meta": {
  "time": "<date-time>",
  "processTime": "<float>",
  "extra": {...}
}
},
{...}
  ],
  "meta": {
  "extra": {
  "api_key_id": "<string>",
  "company_id": "<string>",
  "product": "<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 de creación del documento en formato ISO 8601.
updatedAt	Fecha y hora de la última actualización del documento en formato ISO 8601.
eventId	Identificador del evento asociado, representado como una cadena de texto.
request	Objeto que contiene la información de la petición.
action	Acción realizada, representada como una cadena de texto.
status	Estado de la acción, representado como una cadena de texto.
message	Mensaje asociado a la acción, representado como una cadena de texto.
processTime	Tiempo de procesamiento en milisegundos, representado como un número entero.
flow	Lista de objetos que representan el flujo de procesamiento.
meta	Metadatos adicionales del documento.

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

Parámetro	Descripción
id	Identificador único de la petición, representado como una cadena de texto.
ip	Dirección IP desde donde se realizó la petición, representada como una cadena de texto.
method	Método HTTP utilizado en la petición, representado como una cadena de texto.
statusCode	Código de estado HTTP de la respuesta, representado como un número entero.
path	Ruta de la API solicitada, representada como una cadena de texto.
meta	Metadatos adicionales de la petición.

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

Parámetro	Descripción
resource	Recurso involucrado en el flujo, representado como una cadena de texto.
status	Estado del recurso en el flujo, representado como una cadena de texto.
message	Mensaje asociado al recurso, representado como una cadena de texto.
meta	Metadatos adicionales del recurso.

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

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

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

Parámetro	Descripción
api_key_id	Identificador de la clave API, representado como una cadena de texto.
company_id	Identificador de la compañía, representado como una cadena de texto.
product	Producto asociado a la petición, representado como una cadena de texto.

Ejemplos de Solicitudes

curl --request GET \
--url 'https://sandbox.api.jaak.ai/api/v1/passwordless/event/66b29aff6dfe7dad6f172dd6' \
--header 'accept: application/json' \
--header 'Authorization: Bearer <accessToken>' \

{
  "id": "66b29aff6dfe7dad6f172dd6",
  "createdAt": "2024-08-06T21:51:59.039Z",
  "updatedAt": "2024-08-06T21:51:59.039Z",
  "eventId": "105ccd7c-d10c-40c9-807d-85b583f141ed",
  "request": {
  "id": "66b29a5a6dfe7dad6f172dd2",
  "ip": "169.254.169.126",
  "method": "post",
  "statusCode": 200,
  "path": "/api/v2/document/extract",
  "meta": {
  "request": {
  "country": "MEX",
  "document": "https://storage.googleapis.com/dev-nfury-media/e9f66257-5097-41cf-a229-30a32a0d2b2b.media?X-Goog-Algorithm=GOOoog-SignedHeaders=host",
  "hasBackSide": true,
  "includeOCR": true,
  "side": "BACK",
  "type": "INE_GH"
},
  "response": null
}
},
  "action": "front-extract-document",
  "status": "success",
  "message": "",
  "processTime": 2584,
  "flow": [
{
  "resource": "ocr-document",
  "status": "success",
  "message": "",
  "meta": {
  "time": "2024-08-06T21:51:56.927Z",
  "processTime": 1834.84,
  "extra": {
  "evaluation": {
  "recognized_text": "ELECE IEEEMLII LAODILAALAS\nINE\nH3O0991\nLL\nEDMUNDO ACOBO MOIINA\nSECRETAHIO EJECUTIVOODL\nIINSTITUTO NACIONAL ELFCTORAL\nIDMEXxxxxxxxxxx\u003c\u003c4275086311665\nxxxxxxxxxxxxxxxMEX\u003c01\u003c\u003c53272\u003c6\nRAMIREZ\u003cMORALES\u003c\u003cCRISTIAN\u003c\u003c\u003c\u003c\u003c"
}
}
}
},
{
  "resource": "type-document",
  "status": "success",
  "message": "",
  "meta": {
  "time": "2024-08-06T21:51:58.995Z",
  "processTime": 0.1,
  "extra": {
  "evaluation": {
  "country": "MEX",
  "side": "BACK",
  "type": "INE"
}
}
}
}
  ],
  "meta": {
  "extra": {
  "api_key_id": "<api_key_id>",
  "company_id": "<company_id>",
  "product": "document"
}
}
}

Todos los eventos Document

Petición

Descripción de los parámetros

Respuesta

Descripción de los parámetros

Descripción de los parámetros del objeto docList

Buscar evento por Id

Petición

Descripción de los parámetros

Respuesta

Descripción de los parámetros

Descripción de los parámetros del objeto request

Descripción de los parámetros 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 los parámetros del objeto `docList`

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

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

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

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