Get

Devuelve información sobre la tarea mediante el ID de la tarea. Con este método, puede comprobar el estado de la tarea usando el identificador que recibió al iniciarla.

Solicitud HTTP

GET https://api-{location-id}.flexicapture.com/v2/task/{id}

Reemplace {location-id} por la ubicación compatible.

Parámetros de ruta

Parámetro	Tipo	Descripción
`id`	path, string	Obligatorio. ID de la tarea.

Respuesta

Si la solicitud se procesa correctamente, el cuerpo de la respuesta contiene una instancia de CaptureTask.

{
  "id": "string",
  "number": "string",
  "verification_id": "string",
  "type": "ic",
  "properties": {
    "property_name": "string"
  },
  "email": "string",
  "account": "string",
  "application": "string",
  "created": "YYYY-MM-DDT00:00:00.000",
  "started": "YYYY-MM-DDT00:00:00.000",
  "action_required": "YYYY-MM-DDT00:00:00.000",
  "billed": "YYYY-MM-DDT00:00:00.000",
  "delivered": "YYYY-MM-DDT00:00:00.000",
  "deleted": "YYYY-MM-DDT00:00:00.000",
  "progress": 0,
  "status": "Submitted",
  "is_deleted": true,
  "is_demo": true,
  "is_billed": true,
  "documents_count": 0,
  "pages_count": 0,
  "documents": [
    {
      "files": {},
      "data": {},
      "is_moved": true
    }
  ]
}

CaptureTask

Campo	Tipo	Descripción
`id`	string	Obligatorio. ID único de la tarea.
`number`	string	Obligatorio. Número de tarea.
`verification_id`	string	Obligatorio. Este ID se utiliza para abrir la página de verificación, es decir, `https://{cloud-host}/verification/{verification_id}`.
`type`	string	Obligatorio. Tipo de tarea. Tipos admitidos: `ic`: captura de facturas, `dc`: captura de documentos.
`properties`	object	Opcional. Configuración de procesamiento o parámetros de registro personalizados. Cualquier cantidad de pares nombre-valor.
`email`	string	Obligatorio. Dirección de correo electrónico utilizada para crear la tarea.
`account`	string	Obligatorio. ID de la cuenta utilizado para crear la tarea.
`application`	string	Obligatorio. ID de la aplicación utilizado para crear la tarea.
`created`	string ($date-time)	Obligatorio. Fecha de creación de la tarea.
`started`	string ($date-time)	Opcional. Fecha de inicio de la tarea.
`action_required`	string ($date-time)	Opcional. Fecha en la que la tarea pasó al estado WaitForAction.
`billed`	string ($date-time)	Opcional. Fecha de facturación de la tarea.
`delivered`	string ($date-time)	Opcional. Fecha de finalización de la tarea.
`deleted`	string ($date-time)	Opcional. Fecha de eliminación de los datos.
`progress`	number ($double)	Obligatorio. Progreso general de la tarea.
`status`	string	Obligatorio. Estado de finalización de la tarea. Estados disponibles: `Submitted`, `InProgress`, `WaitForAction`, `Done`, `Failed`, `Canceled`.
`is_deleted`	boolean	Obligatorio. Especifica si se eliminaron los datos de la tarea.
`is_demo`	boolean	Obligatorio. Especifica si la tarea se creó en la aplicación demo.
`is_billed`	boolean	Obligatorio. Especifica si la tarea se facturó.
`documents_count`	integer ($int32)	Opcional. Número de documentos de la tarea.
`pages_count`	integer ($int32)	Opcional. Número de páginas de la tarea.
`documents[]`	object (DataCaptureDocumentModel)	Obligatorio. Documentos de la tarea.

DataCaptureDocumentModel

Campo	Tipo	Descripción
`files`	objeto (DataCaptureFileLinkModel)	Obligatorio. Lista de archivos vinculados al documento.
`data`	cadena	Opcional. Datos del documento.
`is_moved`	booleano	Obligatorio. El documento se eliminó durante la verificación.

DataCaptureFileLinkModel

Campo	Tipo	Descripción
`id`	string	Obligatorio. ID del archivo.
`token`	string	Obligatorio. Token de acceso al archivo.
`name`	string	Obligatorio. Nombre del archivo.

Administrator's Guide

Administration Guide

Performance Guide

Troubleshooting

Cloud

Solicitud HTTP

Parámetros de ruta

Respuesta

CaptureTask

DataCaptureDocumentModel

DataCaptureFileLinkModel

​Solicitud HTTP

​Parámetros de ruta

​Respuesta

​CaptureTask

​DataCaptureDocumentModel

​DataCaptureFileLinkModel

Solicitud HTTP

Parámetros de ruta

Respuesta

CaptureTask

DataCaptureDocumentModel

DataCaptureFileLinkModel