Skip to main content
PUT
Trigger action

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

UUID of the content resource (returned by POST /content). UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

Query Parameters

action
enum<string>
required

Server-side action to run against the content. scan triggers synchronous OCR; the result is persisted on the resource.

Available options:
scan
organizationId
string

Organization scope for the request. Required when the caller has access to more than one organization; auto-inferred otherwise. UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$

Response

OK

id
string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$
personId
string

UUID without dashes (32-character hex string)

Pattern: ^[0-9a-fA-F]{32}$
contentType
string
isTemporary
boolean
signatureType
enum<string>
Available options:
EU
signatureUrl
string
name
string
description
string
qrScan
string

Decoded fiscal QR string as sent in the qrScan request header on POST. Omitted when the resource has no QR data attached. Currently populated for Portuguese receipts.

scanResult
object
read-only
Last modified on August 31, 2026