Send a lead

{
  "firstName": "Thomas",
  "lastName": "Pesquet",
  "email": "[email protected]",
  "phoneNumber": "+33123456789",
  "additionalDetails": "Looking to purchase a house in the suburbs.",
  "monthlyDebt": 500,
  "monthlyIncome": 3000,
  "savingsAvailable": 20000,
  "postalCode": "75001",
  "additionalContext": {
    "id": "ac93af55-671b-47c9-a80d-6a7600b3e561",
    "url": "https://example.com/property/ac93af55",
    "title": "Charming 3-bedroom house",
    "description": "A beautiful house located in a quiet neighborhood, with a large garden and modern amenities.",
    "price": 1500000,
    "latitude": 48.866667,
    "longitude": 2.333333,
    "size": 120,
    "rooms": 3,
    "images": [
      "https://example.com/image1.jpg",
      "https://example.com/image2.jpg"
    ],
    "energyPerformanceCertificate": "B",
    "isBridgeLoan": true,
    "leasingReason": "BANK_LOAN_REFUSAL",
  }
}

POST

lead

{
  "firstName": "Thomas",
  "lastName": "Pesquet",
  "email": "[email protected]",
  "phoneNumber": "+33123456789",
  "additionalDetails": "Looking to purchase a house in the suburbs.",
  "monthlyDebt": 500,
  "monthlyIncome": 3000,
  "savingsAvailable": 20000,
  "postalCode": "75001",
  "additionalContext": {
    "id": "ac93af55-671b-47c9-a80d-6a7600b3e561",
    "url": "https://example.com/property/ac93af55",
    "title": "Charming 3-bedroom house",
    "description": "A beautiful house located in a quiet neighborhood, with a large garden and modern amenities.",
    "price": 1500000,
    "latitude": 48.866667,
    "longitude": 2.333333,
    "size": 120,
    "rooms": 3,
    "images": [
      "https://example.com/image1.jpg",
      "https://example.com/image2.jpg"
    ],
    "energyPerformanceCertificate": "B",
    "isBridgeLoan": true,
    "leasingReason": "BANK_LOAN_REFUSAL",
  }
}

This endpoint is used to send a lead to Hestia.

Make sure you have the user consent before sending us the lead. We will contact it.

Parameters

{
  "firstName": "Thomas",
  "lastName": "Pesquet",
  "email": "[email protected]",
  "phoneNumber": "+33123456789",
  "additionalDetails": "Looking to purchase a house in the suburbs.",
  "monthlyDebt": 500,
  "monthlyIncome": 3000,
  "savingsAvailable": 20000,
  "postalCode": "75001",
  "additionalContext": {
    "id": "ac93af55-671b-47c9-a80d-6a7600b3e561",
    "url": "https://example.com/property/ac93af55",
    "title": "Charming 3-bedroom house",
    "description": "A beautiful house located in a quiet neighborhood, with a large garden and modern amenities.",
    "price": 1500000,
    "latitude": 48.866667,
    "longitude": 2.333333,
    "size": 120,
    "rooms": 3,
    "images": [
      "https://example.com/image1.jpg",
      "https://example.com/image2.jpg"
    ],
    "energyPerformanceCertificate": "B",
    "isBridgeLoan": true,
    "leasingReason": "BANK_LOAN_REFUSAL",
  }
}

string

required

The user first name.

string

required

The user last name.

string

required

The user email.

string

required

The user phone number.

string

Any additional details about the user project / situation.

number

required

The total loan repayments per month. This field is used to calculate the debt ratio.

number

required

The net income per month.

number

required

The total amount of his assets (real estate, passbooks, current account, liquid investments at 15 months…etc).

string

required

Postal code of purchase project.

object

Show properties

string

The unique identifier for the asset.

string

The URL link to the detailed asset listing.

string

A brief title describing the asset.

string

A detailed description of the asset, including features and amenities.

number

The listing price of the asset in euros.

number

The latitude of the asset location.

number

The longitude of the asset location.

number

The total size of the asset in square meters.

number

The total number of rooms in the asset.

array

An array of URLs linking to images of the asset.

string

The Energy Performance Certificate (EPC or DPE in french) rating of the asset.

boolean

Indicates whether the user is seeking a bridge loan.

string

The reason the user is exploring leasing options.
Possible values are BANK_LOAN_REFUSAL if the bank has denied a loan, or ANTICIPATE_LOAN_REJECTION if the user anticipates loan rejection.

Response

If you get a 201, we got the lead!

Get Started

Endpoints

Parameters

Response

​Parameters

​Response

Parameters

Response