Skip to main content
GET
/realms/{realmId}/organizations/{organizationId}/attachments/{attachmentId}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

realmId
string
required
organizationId
string
required
attachmentId
string
required

Response

200 - application/json

Successful response

id
string
required
realmId
string
required
organizationId
string
required
status
enum<string>
required

Lifecycle of a stored file: PENDING_UPLOAD once created and an upload URL has been issued, AVAILABLE once the upload is confirmed, DELETED after removal. Deletion is permanent — an attachment cannot be restored.

Available options:
PENDING_UPLOAD,
AVAILABLE,
DELETED
name
string
required
contentType
string
required
ai
object
required

The wire/event-payload shape — one mapper, shared by every HTTP response and event dispatch.

thumbnail
object
required

The attachment's preview image. Always present; check status before reading data.

fiscal
object
required

Progress of the fiscal-data extraction that fills extractedReceipt. Always present; a PENDING/PROCESSING status means the file has not been read yet, which is why an extractedReceipt can be absent from a document that does have one.

createdBy
string
required
sizeBytes
number
image
object

Dimensions and format of the original file. Absent when the file's header could not be read.

⚠️ width and height are in PIXELS for an image and in POINTS (1/72 inch) for a PDF — check format to tell which. An A4 page reports 595 x 842 points, not pixels.

summary
string
contents
string[]
extractedReceipt
object

The fiscal document this file represents — a nota fiscal or an invoice. Absent unless the file is one and its details are known. Every field inside is optional: null-check your way in, and read status before rendering any amount.

createdAt
string
updatedAt
string
deletedAt
string
deletedBy
string