Retrieve a Document

Idexa provides two ways to obtain the processing result.
The first is a standard GET method, where you must send the ID received during the upload.

The second method is via Webhook. Don’t worry — we will send the result to you.
We will show in the next step how to configure it.

Document Service - Retrieve Document

GET Environment URL/documents/[id]

The /documents/[id] method receives the following parameters, where [id] is the document's UUID.

Header

Identifier	Value
Content-type	application/json
IDEXA-API-KEY	[api_key]

Response

Status code 200

A 200 HTTP code is returned when the document is successfully retrieved.

Parameter	Description	Type	Examples
id	Internal document ID	UUID	"95893394-337c-429c-..."
externalId	External ID for document tracking (cannot be duplicated)	String	"0001"
type	Type of the document sent	Integer	1
data	Object returned by the AI	Model related to the document type	json_object
processTime	Processing time	Float	10.02232
status	Document status (0-Received, 1-Finished, 2-Error)	Integer	3
statusDesc	Document status description (RECEIVED, FINISHED, ERROR)	String	"FINISHED"
createdAt	Record creation timestamp	Datetime	"01/01/2023 00:00:00.0000"
updatedAt	Record update timestamp	Datetime	"01/01/2023 00:00:00.0000"

Example

{
  "id": "bc1bc4ea-8964-4bb7-97cc-2d77d39908d8",
  "externalId": "0001",
  "type": 1,
  "data": {
    // Verificar em Modelo o resultado esperado desse documento
  },
  "processTime": null,
  "status": 1,
  "statusDesc": "FINISHED",
  "createdAt": "2022-10-14 14:38:50.045316",
  "updatedAt": "2022-10-14 14:38:50.045316"
}