Analyze a Rental file

Analyze a rental file

Create a new RentalFile object

API

info

A note about the meta field

The meta field allow you to include external information about this rental file.

You can use it to store:

• information like unique identifier to link a rental file to your internal system
• information like user inputs in your system that can be relevant in the analysis process

To interact with the API directly see the Create rental file section

You can use the following example directly

Single applicant

{
  "applicants_situation": "SINGLE",
  "meta": {
    "my_system_id": "FR123"
  },
  "applicants": [
    {
      "first_name": "Jean",
      "last_name": "Dupond",
      "meta": {
        "my_system_id": "A123"
      }
    }
  ]
}

A couple of applicants

{
  "applicants_situation": "COUPLE",
  "meta": {
    "my_system_id": "FR123"
  },
  "applicants": [
    {
      "first_name": "Jean",
      "last_name": "Dupond",
      "meta": {
        "my_system_id": "A123"
      }
    },
    {
      "first_name": "Marie",
      "last_name": "Dupond",
      "meta": {
        "my_system_id": "A124"
      }
    }
  ]
}

These will returns:

{
  "id": "fc8bc64a-0d40-439b-afdd-ee9cf1475ce2",
  "product_id": null,
  "meta": {
    "my_system_id": "FR123"
  },
  "status": "NEW",
  "applicants_situation": "COUPLE",
  "archived_at": null,
  "tags": [],
  "managers": [],
  "created_at": "2025-04-21T12:10:26.243650Z",
  "updated_at": "2025-04-21T12:10:26.252619Z",
  "score": null,
  "completion_rate": null,
  "applicants": [
    {
      "first_name": "Jean",
      "last_name": "Dupond",
      "email": null,
      "phone": null,
      "id": "217eb57b-6cf5-4430-97c0-de71dd2b2ba0",
      "status": "NEW",
      "form_submitted": null,
      "score": null,
      "created_at": "2025-04-21T12:10:26.243667Z",
      "updated_at": null,
      "is_guarantor": false,
      "physical_guarantors": [],
      "moral_guarantor": null,
      "meta": {
        "my_system_id": "A123"
      },
      "profile": null,
      "completion_rate": null,
      "is_pre_application": false,
      "pre_application_validated_at": null,
      "documents": [],
      "financial_resume": null
    },
    {
      "first_name": "Marie",
      "last_name": "Dupond",
      "email": null,
      "phone": null,
      "id": "fe771a79-e0b0-41a8-be13-3fe83a3867ce",
      "status": "NEW",
      "form_submitted": null,
      "score": null,
      "created_at": "2025-04-21T12:10:26.243688Z",
      "updated_at": null,
      "is_guarantor": false,
      "physical_guarantors": [],
      "moral_guarantor": null,
      "meta": {
        "my_system_id": "A124"
      },
      "profile": null,
      "completion_rate": null,
      "is_pre_application": false,
      "pre_application_validated_at": null,
      "documents": [],
      "financial_resume": null
    }
  ],
  "decision": "PENDING",
  "product": null,
  "is_pre_application": false,
  "pre_application_validate_at": null,
  "comments": [],
  "analysis_required_at": null
}

A couple of applicants with physical guarantors

Console

1. Go to "Applications" > Create a new Rental file

Uploads applicant's documents

Retrieve the results