GetInfo

Método utilizado para obtener los datos de un documento

Para consultar los datos de un documento podemos generar la siguiente solicitud con el archivo payload.json:

curl "https://agents.boolfy.com/api/documents/getinfo" \ 
    -H "Authorization: Bearer BOOLFY_BEARER_KEY" \
    -H "Content-Type: application/json" \
    -d @payload.json

El archivo payload.json debe tener el siguiente formato:

{
    "identifier": "5a37b2ab-551b-4380-aa88-b808e3352d66"
}

Detallamos en forma completa los campos de la solicitud:

Campo
Descripción

Identifier

Especifica el identificador único de Boolfy para el documento. Este dato se proporciono en Upload y en Callback.

Respuesta

La respuesta exitosa para la consulta de datos del documentos es:

{
    "code": 200,
    "msg": null,
    "response": "[{\"Identifier\":\"5a37b2ab...",\"Pages\":2,\"Filename\":\"...}]"
}

Detallamos el contenido del campo Response:

Campo
Descripción

Identifier

Especifica el identificador único de Boolfy para el documento

State

Especifica el estado del documento. Ver Estados de revisión

Process

Especifica el estado del proceso. Ver Estados del proceso

Filename

Especifica el nombre del documento, si este fue proporcionado

Number

Especifica el número asignado al documento, por el numerador de documentos.

Pages

Especifica la cantidad de paginas del documento

ExternalCode

Especifica el identificador en tu plataforma del documento

UploadDate

Especifica la fecha de carga del documento en Boolfy Agents. Formato de respuesta: yyyy/mm/dd hh:mm:ss

Images

Listado de Image de cada pagina del documento. Ver Image

Rules

Listado de reglas aplicadas al documento. Ver Rule

{Campos}

Campos y valores del Agente vinculado al documento

Image

Detallamos el contenido del campo Image:

Campo
Descripción

Image

Especifica el identificador de la imagen. Este valor se utiliza en el método GetImage

Page

Especifica el número de pagina que representa la imagen

Rule

Detallamos el contenido de cada Rule:

Campo
Descripción

Rule

Especifica el identificador único de la regla. Este valor no se modifica y se puede tomar como identificador único de la misma

Name

Especifica el nombre de la regla

Leyend

En caso de fallar la regla, en este campo se especifica información adicional

Pass

Especifica si la regla se cumple. Valore posibles: true, false.

Última actualización