Attachments


Certain checks require a supporting document or documents to be uploaded with the order. This could be a signed form or proof of identification. See the check specific documentation to find out which document is required for each check, if any. During the processing of an order, Verifile might upload documents to support the final report as evidence.

The API has the ability to upload and download documents. It is also possible to upload files to an order via the Verifile Web Application. This can be performed by both candidate and client users.

Upload attachment

To upload an attachment to an order, you need to provide the following parameters:

fileTokenThis is a unique GUID string. It is not possible to upload more than one file with the same fileToken.
orderIdThis is the ID of the order you wish the file to be attached to.
fileNameThis is the name of the file including the file extension.
descriptionThis is an optional field to provide some context to the file being uploaded.

The body will contain the byte string of the file.

If the upload is successful, the same values are returned in the response along with a Checksum which is a MD5 hash of the file.

POST /api/v1/attachments

Restrictions

There are restrictions with uploading files and the upload will not be allowed if these restrictions are broken.

The response will provide:

  • Allowed File types
  • Maximum File Size
  • Minimum File Size

The maximum file size is 20MB, minimum file size is 100 bytes and allowed file extensions are:

.bmp.jpg.tif
.csv.ods.tiff
.doc.odt.txt
.docx.pdf.xls
.gif.png.xlsx
.htm.ppt.xml
.html.pptx.xps
.jpeg.rtf
GET /api/v1/attachments/restrictions

Get Attachment Info

For attachments relating to an order, provide an order ID as a parameter to the following method:

If the order has any attachments, then they will be listed as an array containing:

  • fileToken
  • fileName
  • fileDescription
  • orderId
  • checksum
GET /api/v1/attachments

Downloading an attachment

To download an attachment, provide the unique fileToken of the file as a parameter:

The response body will be a byte string of the file requested.

GET /api/v1/attachments/download