Skip to main content

RentalFile

iduuidrequired
statusStatusD7bEnum (string)required

Possible values: [NEW, OPEN, PROCESSING, HUMAN_ACTION_REQUIRED, COLLECTED, ANALYZED, CLOSED]

score object
anyOf
number
form_completion object
anyOf
number
ttl object

Period after which this file will be automatically deleted.

anyOf
string
created_atdate-timerequired
last_updatedate-timerequired
property_rent object
anyOf
string
applicants object[]
  • Array [
    • iduuidrequired
    first_name object
    anyOf
    string

    Possible values: <= 128 characters

    last_name object
    anyOf
    string

    Possible values: <= 128 characters

    email object
    anyOf
    string

    Possible values: <= 254 characters

    score object
    anyOf
    number
    last_updatedate-timerequired
    alerts object[]
  • Array [
    • alert_typeAlert Type (string)required
    documentDocument (string)required
    document_typeDocument Type (string)required
    status object
    anyOf
    string

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

    comment object
    anyOf
    string
    codeCode (string)required
  • ]
    • statusStatusB55Enum (string)required

    Possible values: [NEW, OPEN, COLLECT_STARTED, COLLECT_COMPLETE, PROCESSING, HUMAN_ACTION_REQUIRED, ANALYZED, COLLECTED, CLOSED]

    is_guarantor object
    anyOf
    boolean
    form_submitted object
    anyOf
    string
  • ]
    • applicants_situation object
    anyOf
    string

    Possible values: [SINGLE, COUPLE, ROOMATES, SOLID_ROOMATES]

    manager object
    anyOf
    string
    manager_name object
    anyOf
    string
    reference object
    anyOf
    string
    RentalFile
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "NEW",
      "score": 0,
      "form_completion": 0,
      "ttl": "string",
      "created_at": "2024-07-29T15:51:28.071Z",
      "last_update": "2024-07-29T15:51:28.071Z",
      "property_rent": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "applicants": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "first_name": "string",
          "last_name": "string",
          "email": "user@example.com",
          "score": 0,
          "last_update": "2024-07-29T15:51:28.071Z",
          "alerts": [
            {
              "alert_type": "string",
              "document": "string",
              "document_type": "string",
              "status": "NEUTRAL",
              "comment": "string",
              "code": "string"
            }
          ],
          "status": "NEW",
          "is_guarantor": true,
          "form_submitted": "2024-07-29T15:51:28.071Z"
        }
      ],
      "applicants_situation": "SINGLE",
      "manager": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "manager_name": "string",
      "reference": "string"
    }