FileProblem

RFC 9457 problem details returned when an uploaded file is rejected. error and message mirror type and detail for existing clients and will be removed in a future version.

typestring

Stable identifier of the rejection

Possible values: [tag:EmptyFile, tag:InvalidFileName, tag:UnsupportedFileType, tag:FileTooLarge, tag:InvalidContentType, tag:InvalidFileSignature, tag:InvalidFileEncoding, tag:InvalidFile]

Example: tag:UnsupportedFileType

titlestring

Short summary of the rejection

Example: Unsupported file type

statusinteger<int32>

HTTP status code

Example: 415

detailstring

Explanation specific to this file

Example: Unsupported file type: malware.exe

errorstringdeprecated

Deprecated, use type

Example: UNSUPPORTED_FILE_TYPE

messagestringdeprecated

Deprecated, use detail

Example: Unsupported file type: malware.exe

fileNamestring | nullnullable

Name of the rejected file, for tag:FileTooLarge

Example: plan.pdf

documentTypestring | nullnullable

Detected document type, for tag:FileTooLarge

Example: PDF

fileSizeBytes(integer | null)<int64>nullable

Size of the rejected file in bytes, for tag:FileTooLarge

Example: 734003200

maxFileSizeBytes(integer | null)<int64>nullable

Maximum size allowed for this document type in bytes, for tag:FileTooLarge

Example: 524288000

FileProblem

{
  "type": "tag:UnsupportedFileType",
  "title": "Unsupported file type",
  "status": 415,
  "detail": "Unsupported file type: malware.exe",
  "fileName": "plan.pdf",
  "documentType": "PDF",
  "fileSizeBytes": 734003200,
  "maxFileSizeBytes": 524288000
}