Skip to main content

ListDocument

iduuid
document_type object
anyOf
nameName (string)required
max_pagesMax Pages (integer)
Default value: 1
analyzed_asAnalyzed As (string)

Possible values: [ID, PAY_SLIP, TAX_NOTICE, STUDENT_CARD, NOT_ANALYZED]

Default value: NOT_ANALYZED
examplesstring[]
Default value: []
to_download object
anyOf
string
iduuid
tenantTenant (string)required
statusStatus (string)

Possible values: [RECEIVED, PROCESSING, PROCESSED, EXTRACTING, EXTRACTED, VALIDATING, VALIDATED, COLLECTED, ACTION_REQUIRED, APPLICANT_ACTION_REQUIRED, REJECTED]

Default value: RECEIVED
created_atdate-time
updated_at object
anyOf
string
detected_model object
anyOf
string
alerts object[]
  • Array [
    • codeCode (string)required
    statusStatus (string)required

    Possible values: [SUCCESS, WARNING, ERROR, NEUTRAL]

    comment object
    anyOf
    string
    alert_type objectrequired
    idId (string)required
    nameName (string)required
    descriptionDescription (string)required
  • ]
    • files object[]
  • Array [
    • file_iduuidrequired
    file objectrequired
    anyOf
    string

    Possible values: non-empty and <= 2083 characters

    thumbnail objectrequired
    anyOf
    string

    Possible values: non-empty and <= 2083 characters

    images objectrequired
    anyOf
  • Array [
    • uri

    Possible values: non-empty and <= 2083 characters

  • ]
    • pagesinteger[]
    Default value: []
  • ]
    • ListDocument
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "document_type": {
        "name": "string",
        "max_pages": 1,
        "analyzed_as": "NOT_ANALYZED",
        "examples": [
          "string"
        ],
        "to_download": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenant": "string"
      },
      "status": "RECEIVED",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "detected_model": "string",
      "alerts": [
        {
          "code": "string",
          "status": "SUCCESS",
          "comment": "string",
          "alert_type": {
            "id": "string",
            "name": "string",
            "description": "string"
          }
        }
      ],
      "files": [
        {
          "file_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "file": "string",
          "thumbnail": "string",
          "images": [
            "string"
          ],
          "pages": [
            0
          ]
        }
      ]
    }