Skip to main content

DocumentSection

iduuid
title object
anyOf
string
description object
anyOf
string
componentComponent (string)
Default value: DocumentCollectSection
mandatoryMandatory (boolean)
Default value: false
display_condition object
anyOf
root objectrequired
kind

Possible values: [atom, group]

related_section objectrequired
anyOf
integer
comparatorComparator (string)

Possible values: [eq, in, contains, regex, truthy, falsy]

Default value: eq
value object
anyOf
string
documents object[]
  • Array [
  • 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
    iduuidrequired
  • ]
  • min_docsMin Docs (integer)
    Default value: 1
    completedCompleted (boolean)
    Default value: false
    uploads object[]
  • Array [
  • nameName (string)required
    number_of_pages object
    anyOf
    integer
    size object
    anyOf
    integer
    created_atdate-time
    updated_atdate-time
    statusStatus (string)

    Possible values: [RECEIVED, REJECTED, PROCESSED, EXTRACTING, EXTRACTED]

    Default value: RECEIVED
    mime_typeMime Type (string)required
    uploaded_for_section object
    anyOf
    string
    document_type object
    anyOf
    string
    applicantuuidrequired
    created_by object
    anyOf
    string
    metaMeta
    reject_reason object
    anyOf
    reasonReason (string)required

    Possible values: [TOO_MANY_PAGES, INCOMPLETE_DOCUMENT, UNREADABLE_DOCUMENT, WRONG_DOCUMENT, NOT_SUPPORTED, UNPROCESSABLE]

    comment object
    anyOf
    string
    iduuidrequired
  • ]
  • displayDisplay (boolean)
    Default value: true
    DocumentSection
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "title": "string",
    "description": "string",
    "component": "DocumentCollectSection",
    "mandatory": false,
    "display_condition": {
    "root": {
    "kind": "group",
    "operator": "AND",
    "negate": false,
    "children": [
    null,
    {
    "kind": "atom",
    "related_section": 0,
    "comparator": "eq",
    "value": "string"
    }
    ]
    }
    },
    "documents": [
    {
    "name": "string",
    "max_pages": 1,
    "analyzed_as": "NOT_ANALYZED",
    "examples": [
    "string"
    ],
    "to_download": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    ],
    "min_docs": 1,
    "completed": false,
    "uploads": [
    {
    "name": "string",
    "number_of_pages": 0,
    "size": 0,
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "status": "RECEIVED",
    "mime_type": "string",
    "uploaded_for_section": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "document_type": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "applicant": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_by": "string",
    "reject_reason": {
    "reason": "TOO_MANY_PAGES",
    "comment": "string"
    },
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    ],
    "display": true
    }