List exported photos

The response contains a meta object for pagination and a files array with metadata, optional signature data, the photo as a Base64 string, and a variants array for additional exported versions. Records are sorted by exported_at in ascending order so new exports are appended predictably.

Request parameters

Parameter	Required	Description
page	No	Page number, default 1.
page_size	No	Default 50, maximum 100. Keep it modest because image data is embedded.
customer_no	No	One or more customer numbers. The value is not unique.
site_code	No	One or more exact site codes.

Descending sorting is intentionally unavailable because new records would otherwise move between pages. When a photo has been removed physically, it is also removed from this list.

Delete every photo after it has been persisted successfully. If customer_no occurs more than once, choose using the latest uploaded_at value.

Response

{
  "meta": {
    "page": 1,
    "page_size": 50,
    "total_pages": 1,
    "total_records": 1
  },
  "files": [
    {
      "invitation_key": "Td9gU5juY2Hn",
      "customer_no": "764456789",
      "upload_channel": "deeplink",
      "site_code": "test",
      "qc_status": "passed",
      "user_consent": {
        "use_general": {
          "choice": true,
          "datetime": "2025-02-03T08:40:00Z"
        },
        "use_marketing": {
          "choice": false,
          "datetime": "2025-02-03T08:40:00Z"
        }
      },
      "uploaded_at": "2025-02-03T09:41:08+01:00",
      "exported_at": "2025-02-03T09:42:09+01:00",
      "file_name": "12345678.jpg",
      "file_type": "image/jpeg",
      "file_content": "/9j/4AAQSkZJRgABAQEAYAB...",
      "variants": [
        {
          "suffix": "_web",
          "file_name": "12345678_web.jpg",
          "file_type": "image/jpeg",
          "file_content": "/9j/4AAQSkZJRgABAQEAYAB..."
        }
      ],
      "signature_name": "12345678.png",
      "signature_type": "image/png",
      "signature_content": "iVBORw0KGgoAAAANSUh..."
    }
  ]
}

User consent

Each item in files includes user_consent, using the same format as GET /invitation and GET /search. It is an object keyed by consent category, or null when no valid decisions have been recorded.

Each recorded category contains a boolean choice (true for acceptance, false for refusal) and the original UTC datetime in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). This timestamp is when the decision was recorded, not when the photo was exported or retrieved.

Decisions are collected only for enabled, applicable consent questions. Unanswered categories have no entry; a missing category does not mean refusal. Historical decisions remain available when a category is subsequently disabled or removed. Category names are extensible and can include theme-defined categories in addition to use_general, use_marketing, and enhance_genai.

Image variants

Each item in files includes a variants array containing additional versions of the same photo, such as images with different dimensions or backgrounds. Variants are generated according to the export configuration and included automatically; no request parameter is needed.

Each variant contains:

Field	Type	Description
suffix	String	Configured filename suffix identifying the variant, for example _web.
file_name	String	Exported filename, including its extension. Use this value when saving the file.
file_type	String	MIME type of the variant, for example image/jpeg.
file_content	String	Base64-encoded image data. Decode it before saving.

The top-level file_name, file_type, and file_content fields remain the main exported image. That image is not repeated in variants. If the export configuration excludes the primary photo, the first successfully generated variant becomes the main exported image; any remaining variants appear in variants.

variants is [] when no additional variants are available, including older exports without recorded variants. Only files recorded at export time that still exist and can be read are returned; missing or unreadable variants are omitted. Variants belong to their parent files item and do not count as separate pagination records.

Persist the main image and all required variants before calling DELETE /export with the parent invitation_key. Deleting the export also removes its associated variants.