Upload Document Response

A full description of the upload document request

Example Response




Property Name Description
BytesUploaded The number of bytes uploaded to check against expected number.

The document type as resolved by the service - this can be compared against the expected (submitted) type for validation purposes.

  • None - No type specified / known.
  • JPEG - A JPEG (Joint Picture Experts Group Image).
  • PNG - A PNG (Portable Network Graphics) image.
  • PDF - A PDF (Portable Document Format)
DocumentTypeValidationSucceeded Whether or not the resolved document type matched the type specified by the user (e.g if the user specified the document was a PNG, and the document resolved to a PNG, this value is true).
DocumentUID The system assigned unique Id applied to this document on upload. Used to refer to the document when associating documents with a service as a part of the UploadedFiles element of a Service Request
DocumentReference An echo of the value that was used on submission - useful when operating asynchronously.