Photo Collect API
Photo Collect ↗
GETExports

List exported photos

Retrieve processed photos that are approved and ready for secure downstream storage.

GET/apiv1/export

The response contains a meta object for pagination and a files array with metadata, optional signature data, and the photo as a Base64 string. 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",
      "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...",
      "signature_name": "12345678.png",
      "signature_type": "image/png",
      "signature_content": "iVBORw0KGgoAAAANSUh..."
    }
  ]
}
⌁

Connect your API

Credentials are kept in this session only.