Skip to main content
POST
Create content

Authorizations

Authorization
string
header
required

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

Headers

Content-Type
string
required

MIME type of the request body. Must be image/* or application/pdf; the server also verifies the bytes match the declared type.

Content-Name
string

Optional name for the uploaded content. URL-decoded server-side. Auto-generated if omitted.

Content-Description
string

Optional description for the uploaded content. URL-decoded server-side.

qrScan
string

Optional URL-encoded string extracted from a fiscal QR code on the receipt (currently used for Portuguese receipts). URL-decoded server-side and persisted on the resource; the decoded value is returned in the response and on subsequent reads. Send only when the verification.receiptAttachment field has qrCodeSupported: true (see the fields endpoint) and the client successfully scanned a QR — otherwise omit the header.

Query Parameters

action
enum<string>

Optional server-side action to run against the uploaded content. scan runs 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}$

Body

The body is of type file.

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