Skip to main content

CreateRentalFile

Schema for POST /v2/rental-files.

product_id object

The related product from product API.

anyOf
string
metaMeta
allow_user_engagementAllow User Engagement (boolean)

If enabled, applicants will be able to access their data, and the system will allow email sending

Default value: true
applicants_situation object
anyOf
string

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

applicants object[]
  • Array [
    • first_name object
    anyOf
    string
    last_name object
    anyOf
    string
    email object
    anyOf
    string
    phone object
    anyOf
    string
    metaMeta
    physical_guarantorsundefined[]
    Default value: []
  • ]
    • CreateRentalFile
    {
      "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "allow_user_engagement": true,
      "applicants_situation": "SINGLE",
      "applicants": [
        {
          "first_name": "string",
          "last_name": "string",
          "email": "user@example.com",
          "phone": "string",
          "physical_guarantors": [
            null
          ]
        }
      ]
    }