EntityAttachment Message

The EntityAttachment message is generated to send pictures/signatures.

This message is always sent in conjunction with an Entity message as pictures/signature are also questionnaire answers, but cannot be included in the questionnaire property of Entity message

The data field of an EntityAttachment message always contains the properties described below

Property	Nullable	Type	Description
base64	false	string	A Base64 encoded string containing the attachment
key	false	string	The key of the question in the questionnaire. Each pictures/signature question has a unique key. The key can be used to distinguish between different types of pictures/signatures for the same Entity. For example, a picture of damaged goods might have the `damaged_goods_picture` key while a picture of the CMR might have the `cmr_picture` key.
base64	false	string	The MIME-type of the base64 encoded attachment. By default, both pictures and signatures are sent using MIME-type `image/jpeg`.
number	false	integer	An incrementing counter for the number of attachments sent for the combination of `foreignId`, `flag` and `key`. This value can be used to distinguish between multiple attachment sent for the same entity.

Example

The example below contains the 2nd damage picture taken for an Entity

{
  "type": "EntityAttachment",
  "data": {
    "foreignId": "1234-1",
    "flag": "stop",
    "attachment": {
      "base64": "/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAP//////////////////////////////////////////////////////////////////////////////////////wgALCAABAAEBAREA/8QAFBABAAAAAAAAAAAAAAAAAAAAAP/aAAgBAQABPxA=",
      "key": "damage_picture",
      "mimeType": "image/jpeg",
      "number": 2
    },
    "additionalContext": {}
  },
  "location": {
    "latitude": 52.2531361,
    "longitude": 5.4890928,
    "speedMs": 25,
    "bearing": 75.0
  },
  "origin": {
    "appId": 60000153,
    "deviceId": "358240051111110",
    "driverNumber": "110",
    "coDriverNumber": null
  },
  "vehicle": {
    "licensePlate": "AA-BB-12",
    "odometer": 250030
  },
  "messageTime": "2024-01-17T09:12:47.587Z"
}

Last modified: 22 July 2025