Attachments

The official documents behind the data, downloadable for your records
View as Markdown

Where it lives: on every result that carries documents — e.g. data.employment.labor_check.attachments — and listed session-wide by the attachments endpoint.

Many results carry the original documents they were extracted from — official PDF reports, receipts — as attachments. The result itself only carries the attachment’s description; the bytes are downloaded separately through the session’s attachments endpoint using the attachment’s id, so payloads stay light and you fetch only the files you need.

Attachments follow the session’s lifetime: download what you want to keep while the session is available.

A document attached to a result — an official report, a receipt, an invoice... The entry describes the file; its bytes are downloaded through the execution's attachments endpoint using id.

sub_familyenumRequired

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

idstringRequiredformat: "ObjectId"

Attachment identifier — use it to download the file through the execution's attachments endpoint.

content_namestringRequired
File name of the document.
content_typestringRequiredformat: "mime-type"
MIME type of the content.
metadatamap from strings to anyRequired

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.

Document kinds

sub_family tells you what each document is:

Product Attachment Type