DocumentErrorResponse

idstring(uuid)required

file_namestringrequired

file_typestringrequired

Allowed values:application/pdfimage/pngimage/tiffimage/jpeg

confirmedbooleanrequired

lockedbooleanrequired

Example

Allowed values:not_foundlockeddeletion_failedobject_missing

error_codestringrequired

Machine-readable error code

Allowed values:not_foundlockeddeletion_failedobject_missing

detailstringrequired

Human-readable error message

Example

upload_idstring(uuid)required

A UUID for the upload. This can be used to identify this file in other endpoints to e.g., track the status of the upload or complete the upload.

upload_urlsobjectrequired

URLs to upload each part of the file to. There will be exactly one URL for each part of the file.

num_partsintegerrequired

The number of parts the file should be split into.

Example

file_size_bytesintegerrequired

The size of the file in bytes

schema_codestringrequired

One of a predefined set of schemas that the file must conform to so that it can be processed by Wayflyer

Allowed values:JSON01

Example

DocumentUploadResponse