Skip to main content

This type provides information returned about a created document ID, which may or may not have been uploaded.

Types that use DocumentResponse

Not used by any types.

Calls that use DocumentResponse

GET
/document/{document_id}
POST
/document/{document_id}/upload

Fields

Field
Type
Description
documentId
string
The unique ID of the document.
documentMetadata
DocumentMetadata
This container provides the name, size, and type of the specified file.
documentStatus
DocumentStatusEnum
The status of the document resource.

Once a document has been uploaded using the uploadDocument method, the documentStatus will be SUBMITTED. The document will then either be accepted or rejected. Only documents with the status of ACCEPTED are available to be added to a listing.
documentType
DocumentTypeEnum
The type of the document uploaded. For example, USER_GUIDE_OR_MANUAL.
languages
array of LanguageEnum
This array shows the language(s) used in the document.