Skip to main content
POST
https://api.heyhestia.com/partner
/
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",
  }
}
​
firstName
string
required
The user first name.
​
lastName
string
required
The user last name.
​
email
string
required
The user email.
​
phoneNumber
string
required
The user phone number.
​
additionalDetails
string
Any additional details about the user project / situation.
​
monthlyDebt
number
required
The total loan repayments per month. This field is used to calculate the debt ratio.
​
monthlyIncome
number
required
The net income per month.
​
savingsAvailable
number
required
The total amount of his assets (real estate, passbooks, current account, liquid investments at 15 months…etc).
​
postalCode
string
required
Postal code of purchase project.
​
additionalContext
object

​
Response

If you get a 201, we got the lead!