Evidence photos

Base URL: $BUSINESS_API

The object

idstring · optional
tenant_idstring · optional
client_keystring · optional
referencestring · optional

Value to store on the reading or field order, of the form evidence://{id}.

content_typestring · optional

one of image/jpeg, image/png

size_bytesinteger (int64) · optional
uploaded_bystring · optional
created_atstring (date-time) · optional
The object
{
  "id": "idx_2xBW8Tr0oR5YsrNoIdzQO7t4Gjn",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "client_key": "client key",
  "reference": "REF-2026-000142",
  "content_type": "image/jpeg",
  "size_bytes": 1,
  "uploaded_by": "uploaded by",
  "created_at": "2026-11-19T09:30:00Z"
}

Upload an evidence photo

Logs

POST /evidence-photos

Upload an evidence photo (JPEG or PNG, up to 8 MiB)

Stores a photo taken with a reading or a field order and returns the reference to send as photo_evidence, evidence_photo or in evidence_ids. The content is verified by its bytes; the storage location is generated by the server. Retrying with the same client_key and the same photo returns the original record and stores nothing new. Requires the business:evidence-photos:create scope.

Returns

200 The photo already stored under this client key

Show attributes
idstring · optional
tenant_idstring · optional
client_keystring · optional
referencestring · optional

Value to store on the reading or field order, of the form evidence://{id}.

content_typestring · optional

one of image/jpeg, image/png

size_bytesinteger (int64) · optional
uploaded_bystring · optional
created_atstring (date-time) · optional

Errors 400 · 401 · 403 · 409 · 413 · 415

Permissions business:evidence-photos:create · Roles: admin, field_reader, field_supervisor, operations, owner

curl -X POST "$BUSINESS_API/evidence-photos" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "id": "idx_2xBW8Tr0oR5YsrNoIdzQO7t4Gjn",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "client_key": "client key",
  "reference": "REF-2026-000142",
  "content_type": "image/jpeg",
  "size_bytes": 1,
  "uploaded_by": "uploaded by",
  "created_at": "2026-11-19T09:30:00Z"
}

Read an evidence photo

Logs

GET /evidence-photos/{id}/file

Returns the photo to staff of the owning tenant. Requires the business:evidence-photos:read scope. A photo owned by another tenant answers 404.

Parameters

idstring · path · required

Identifier from the photo's reference

Returns

200 The photo bytes

Errors 401 · 403 · 404

Permissions business:evidence-photos:read · Roles: admin, customer_service, field_supervisor, operations, owner

curl -X GET "$BUSINESS_API/evidence-photos/{id}/file" \
  -H "Authorization: Bearer sk_test_..."
Response 200

The photo bytes