File Upload

Some of the activities on Cybrid platform will require you provide supporting documentation and this guide will walk you through the steps to upload files.

❗️

Important: File upload feature is available to you depending on the Cybrid platform features enabled on your partner. Contact Cybrid if you think you should have access

Uploading a file

To upload a file you use the POST /api/files endpoint. An example request body is below

{
  "type": "utility_bil",
  "filename": "bill.png",
  "customer_guid": "your-customer-guid",
  "content_type": "image/png",
  "data": "base64-encoded-document"
}

type

It is important to choose the file type correctly as it will determine what it can be used for. For example utility_bill can be used as proof of address. Cybrid features relying on files provided by you will have specific requirements on the file types required to support the activity.

data

This API will allow files to be provided inline with the file content encoded using Base64. There is a limit of 10MB on the size of data for files that require more than 10MB. The Base64-encoded string adds approximately 30% to the original file size. For example, a 7MB file will become approximately 9.1MB when encoded. If you need to upload file larger than 10MB please contact Cybrid for instructions.

state

After creation the file will be in storing state, you will not be able to reference the file until the file has been marked with a state completed.