Skip to navigation

List the documents

View as Markdown

Every original document the execution retrieved, described but not downloaded.

Engines do not only extract data: where the source issues a document — a Vida Laboral report, a tax declaration, a CIRBE report, a certificate — the original file is kept with the execution. This endpoint lists them all: what each one is (sub_family), its name, its content type, its size and the id you download it by. The catalogue of types is in Attachments.

The bytes are not here, on purpose. A response carrying half a dozen PDFs inline would be enormous and mostly unwanted. Read the list, decide what you need, and fetch each file with Download a document.

Results reference their own documents inline too — attachments inside a labor check, for instance — with the same identifiers. Both routes lead to the same files.

StatusMeaning
200The documents. An empty list means the execution produced none.
202execution_still_processing — this endpoint waits for the whole execution, unlike the per-family ones.
404No execution with that id for your application, or it has been deleted.

Server to server only. This call is authorised with your application secret: it belongs in your backend, never in a browser, a mobile app or anything your customer can read.

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

execution_idstringRequiredformat: "object-id"
The execution, as the acceptance response returned it.

Response

200 OK
One entry per document the execution retrieved: what it is, its name, its content type, its size and the id you download it by. The bytes are not here, on purpose — a body carrying half a dozen PDFs would be enormous and mostly unwanted.

sub_familyenum

What kind of document this is (e.g. attachment:es-tgss-life-report).

idstringformat: "object-id"

Attachment identifier — what the attachments endpoint of the API that returned the result takes to download the file.

content_namestring
File name of the document.
content_typestringformat: "mime-type"
MIME type of the content.
metadatamap from strings to any

Extra facts about the document, as simple key-value pairs (e.g. its official verification code, its issue date).

product"attachment"OptionalDefaults to attachment

The product type identifier. Always attachment.

content_hashstringOptional
Fingerprint of the content, to verify its integrity.

Errors

404
Not Found Error
422
Unprocessable Entity Error