Overview
Attachments can be added to an incident to provide further information relating to the claim. The attachments endpoint is used to upload a file to the attachment store.
When uploading an attachment, you are returned an attachmentId as part of the response body, this id can be used to link the attachment to an incident or event in the
attachments object of the request body. If you have a publicly available url to the attachment, this step can be skipped and the url can be used in place of the
attachmentId in the attachment object.
Restrictions
Individual attachments must not be larger than 100MB. If uploading attachments directly via the attachments endpoint, the total request size must not exceed 100MB. For example, you can send 5 attachments at 20MB each in the same request, but you couldn't send 3 attachments at 40MB each. In addition only the following list extensions are accepted, if either of these conditions is not met, a validation error will be returned when attempting to upload the attachment.
| doc | docx | xls | xlsx |
| rtf | txt | jpg | jpeg |
| png | bmp | tif | gif |
| html | htm | mp4 | |
| mov | wmv | avi | mkv |
Adding Attachments
Attachments are stored on the Event Log in claims manager. They can be added on either via either the Incident or Event endpoints. Both of these
endpoints include an attachments array which will be a list of the attachment objects, each representing one attachment
that you wish to add in the request. The attachment object properties are listed below:
| Parameter Name | Description | Data Type | Example Data |
|---|---|---|---|
attachmentId
|
The unique identifier of an attachment as received from the attachments endpoint when uploading a file | string ($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
url
|
A publicly accessible url to retrieve the file from | string ($url) | https://www.example.com/file.png |
description
|
Optional description of the attachment being uploaded | string | Test file |
Either the attachmentId or a url should be provided, but not both. Use the attachmentId when you have previously
uploaded the attachment via the /attachments endpoint. Use a url when you want to provide a publicly accessible url for us to go and retrieve
the attachment from when creating the incident or event.
If using the url approach, the url provided must be publicly accessible with a standard get request, no additional headers or authentication can be accommodated. You will also need to provide us the domain where you will be providing these urls from so we can add this to our whitelist.