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://da.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": "Document uploaded",
    "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 del documento
Filename	Especifica el nombre del documento, si este fue proporcionado
ExternalCode	Especifica el identificador en tu plataforma del documento
Pages	Especifica la cantidad de paginas del documento
Images	Listado de Image de cada pagina del documento
{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