AppendFileToSubmissionRequest

Uploads a file to be attached to a submission.

  • file
    Type: string
    required

    Base64-encoded content of the file to be uploaded. Only the Base64-encoded string, without any prefix (e.g., 'data:image/jpeg;base64,'), should be assigned.

  • fileName
    Type: string
    required

    Desired name for the file uploaded

  • documentDescription
    Type: string | null

    Description of the file uploaded

  • documentSubtype
    Type: string | null

    Sub type of the file uploaded.

  • documentType
    Type: string | null

    Type of the file uploaded

  • entityReferenceId
    Type: string | null

    The client provided reference id for the individual, company or trust that this relates to

  • requirementReferenceId
    Type: string | null

    The reference id of the requirement

Examples 
{
  "file": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlL1BhZ2U+PgplbmRvYmoK",
  "fileName": "drivers-licence.pdf",
  "requirementReferenceId": "a6f0c1d2-5b3e-4a77-9c21-0e8b6f4d1a90",
  "entityReferenceId": "CRM-4821",
  "documentType": "IdentityDocument",
  "documentSubtype": "DriversLicence",
  "documentDescription": "Victorian drivers licence, front and back"
}