Skip to main content

DocumentsListResponseDto

totalCountinteger<int64>required

The total number of documents.

previousPagestringnullablerequired

The URL to the previous page of results.

nextPagestringnullablerequired

The URL to the next page of results.

currentPageinteger<int32>required

The current page number.

result object[]required

The list of instructions.

  • Array [
  • idstring<uuid>required

    The unique identifier of the document.

    fileNamestringnullablerequired

    The name of the document.

    createdAtstring<date-time>required

    The date and time when the document was created.

    mimeTypestringrequired

    The mimetype/media type of the file

    Example: application/pdf
    processingStatePublicDocumentStateEnumrequired

    The Processing state of the document.

    Possible values: [Unspecified, Pending, Processed, Error]

    Example: Pending
    processingErrorMessagestringnullable

    The document prosessing error message if a document could not be processed.

    Example: Invalid document type
  • ]
  • DocumentsListResponseDto
    {
    "totalCount": 0,
    "previousPage": "string",
    "nextPage": "string",
    "currentPage": 0,
    "result": [
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "fileName": "string",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "mimeType": "application/pdf",
    "processingState": "Pending",
    "processingErrorMessage": "Invalid document type"
    }
    ]
    }