rentals.search

Return a compact, actionable shortlist of published furnished apartments by location, availability, capacity, rooms, duration, and monthly rent. Defaults to 10 available or upcoming rentals; call rentals.get for complete details.

Parameters11

locale	string	optional
query	string	optional	Free text across rental, property, city, and region names.
city	string	optional	City name; matching is case- and accent-insensitive.
region	string	optional	Region name; common English, German, and unaccented forms are accepted.
availableFrom	string	optional	Latest acceptable move-in date in ISO YYYY-MM-DD; later or unverified upcoming availability is excluded.
availabilityStatus	string	optional	Availability scope. The default excludes unavailable inventory.
minimumRooms	number	optional	Minimum room count.
minimumOccupancy	integer	optional	Minimum supported resident count.
maximumMonthlyRent	number	optional	Maximum monthly rent in CHF for the selected duration.
durationMonths	any	optional	Minimum rental duration used for price filtering.
limit	integer	optional	Maximum shortlist size; inspect total and hasMore.

Raw schema

{
  "type": "object",
  "properties": {
    "locale": {
      "default": "de",
      "type": "string",
      "enum": [
        "de",
        "en"
      ]
    },
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Free text across rental, property, city, and region names."
    },
    "city": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "City name; matching is case- and accent-insensitive."
    },
    "region": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100,
      "description": "Region name; common English, German, and unaccented forms are accepted."
    },
    "availableFrom": {
      "type": "string",
      "format": "date",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$",
      "description": "Latest acceptable move-in date in ISO YYYY-MM-DD; later or unverified upcoming availability is excluded."
    },
    "availabilityStatus": {
      "default": "AVAILABLE_OR_UPCOMING",
      "type": "string",
      "enum": [
        "AVAILABLE_OR_UPCOMING",
        "AVAILABLE",
        "UPCOMING",
        "UNAVAILABLE",
        "ANY"
      ],
      "description": "Availability scope. The default excludes unavailable inventory."
    },
    "minimumRooms": {
      "type": "number",
      "minimum": 0.5,
      "maximum": 20,
      "description": "Minimum room count."
    },
    "minimumOccupancy": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Minimum supported resident count."
    },
    "maximumMonthlyRent": {
      "type": "number",
      "exclusiveMinimum": 0,
      "maximum": 100000,
      "description": "Maximum monthly rent in CHF for the selected duration."
    },
    "durationMonths": {
      "anyOf": [
        {
          "type": "number",
          "const": 3
        },
        {
          "type": "number",
          "const": 6
        },
        {
          "type": "number",
          "const": 12
        }
      ],
      "description": "Minimum rental duration used for price filtering."
    },
    "limit": {
      "default": 10,
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "description": "Maximum shortlist size; inspect total and hasMore."
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

rentals.get

Return localized customer-safe apartment details, verified availability, duration pricing, deposit, included services, terms, eligibility, media, and inquiry/application links.

Parameters2

locale	string	optional
rentalId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "locale": {
      "default": "de",
      "type": "string",
      "enum": [
        "de",
        "en"
      ]
    },
    "rentalId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "rentalId"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

rentals.check_availability

Check the current published availability state and earliest date for one rental. This does not create a hold or reservation.

Parameters2

locale	string	optional
rentalId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "locale": {
      "default": "de",
      "type": "string",
      "enum": [
        "de",
        "en"
      ]
    },
    "rentalId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "rentalId"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

rentals.get_pricing

Return current published monthly pricing by supported duration, parking, deposit, inclusions, payment method, and minimum-stay terms. Pricing is informational until a quote or hold is issued.

Parameters2

locale	string	optional
rentalId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "locale": {
      "default": "de",
      "type": "string",
      "enum": [
        "de",
        "en"
      ]
    },
    "rentalId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "rentalId"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

applications.start

Create or reuse a duplicate-safe applicant workspace for one published rental. Requires explicit current privacy consent and an idempotency key. Email verification is sent to the applicant; the tool never returns the verification URL.

Parameters12

rentalId	string	required
locale	string	optional
journey	string	required
firstName	string	required
lastName	string	required
email	string	required
phone	string	required
desiredDurationMonths	any	optional
requestedParkingCount	any	optional
privacyConsentAccepted	boolean	required
privacyConsentVersion	string	required
idempotencyKey	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "rentalId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "locale": {
      "default": "de",
      "type": "string",
      "enum": [
        "de",
        "en"
      ]
    },
    "journey": {
      "type": "string",
      "enum": [
        "INQUIRY",
        "APPLICATION"
      ]
    },
    "firstName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "lastName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "email": {
      "type": "string",
      "maxLength": 320,
      "format": "email",
      "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
    },
    "phone": {
      "type": "string",
      "minLength": 6,
      "maxLength": 100
    },
    "desiredDurationMonths": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 1,
          "maximum": 120
        },
        {
          "type": "null"
        }
      ]
    },
    "requestedParkingCount": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0,
          "maximum": 10
        },
        {
          "type": "null"
        }
      ]
    },
    "privacyConsentAccepted": {
      "type": "boolean",
      "const": true
    },
    "privacyConsentVersion": {
      "type": "string",
      "const": "2026-07-13"
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "rentalId",
    "journey",
    "firstName",
    "lastName",
    "email",
    "phone",
    "privacyConsentAccepted",
    "privacyConsentVersion",
    "idempotencyKey"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

applications.get_status

Read the privacy-minimized status and next actions for one scoped application session token.

Parameters1

sessionToken

string

required

Raw schema

{
  "type": "object",
  "properties": {
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "sessionToken"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

applications.update

Update bounded applicant, tenancy, and billing data for one email-verified session using its exact current version and a durable idempotency key.

Parameters33

expectedVersion	string	required
preferredLanguage	string	optional
desiredMoveInDate	any	optional
desiredMoveOutDate	any	optional
desiredDurationMonths	any	optional
requestedParkingCount	any	optional
minorCount	any	optional
petSummary	string	optional
applicantMessage	string	optional
employmentStatusSummary	string	optional
employerOrCompanyName	string	optional
tenantProfiles	array	optional
tenantPartyMode	string	optional
companyTenantName	string	optional
companyTenantStreetLine1	string	optional
companyTenantStreetLine2	string	optional
companyTenantPostalCode	string	optional
companyTenantCity	string	optional
companyTenantCountryCode	string	optional
companyTenantSigners	array	optional
billingIntentType	string	optional
billingEmail	any	optional
billingPrivateFirstName	string	optional
billingPrivateLastName	string	optional
companyBillingName	string	optional
billingStreetLine1	string	optional
billingStreetLine2	string	optional
billingPostalCode	string	optional
billingCity	string	optional
billingCountryCode	string	optional
contractLanguageCode	string	optional
sessionToken	string	required
idempotencyKey	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "expectedVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "preferredLanguage": {
      "type": "string",
      "enum": [
        "de",
        "en"
      ]
    },
    "desiredMoveInDate": {
      "anyOf": [
        {
          "type": "string",
          "format": "date",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
        },
        {
          "type": "null"
        }
      ]
    },
    "desiredMoveOutDate": {
      "anyOf": [
        {
          "type": "string",
          "format": "date",
          "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
        },
        {
          "type": "null"
        }
      ]
    },
    "desiredDurationMonths": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 1,
          "maximum": 120
        },
        {
          "type": "null"
        }
      ]
    },
    "requestedParkingCount": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0,
          "maximum": 10
        },
        {
          "type": "null"
        }
      ]
    },
    "minorCount": {
      "anyOf": [
        {
          "type": "integer",
          "minimum": 0,
          "maximum": 20
        },
        {
          "type": "null"
        }
      ]
    },
    "petSummary": {
      "type": "string",
      "maxLength": 2000
    },
    "applicantMessage": {
      "type": "string",
      "maxLength": 10000
    },
    "employmentStatusSummary": {
      "type": "string",
      "maxLength": 2000
    },
    "employerOrCompanyName": {
      "type": "string",
      "maxLength": 500
    },
    "tenantProfiles": {
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "isMainTenant": {
            "type": "boolean"
          },
          "firstName": {
            "type": "string",
            "maxLength": 100
          },
          "lastName": {
            "type": "string",
            "maxLength": 100
          },
          "birthDate": {
            "anyOf": [
              {
                "type": "string",
                "format": "date",
                "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "identityDocumentType": {
            "type": "string",
            "enum": [
              "PASSPORT",
              "EU_ID"
            ]
          },
          "passportOrIdNumber": {
            "type": "string",
            "maxLength": 200
          },
          "phone": {
            "type": "string",
            "maxLength": 100
          },
          "email": {
            "anyOf": [
              {
                "type": "string",
                "const": ""
              },
              {
                "type": "string",
                "maxLength": 320,
                "format": "email",
                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
              }
            ]
          },
          "nationalityCode": {
            "type": "string",
            "maxLength": 10
          },
          "permitStatus": {
            "type": "string",
            "enum": [
              "SWISS_CITIZEN",
              "EU_EFTA_CITIZEN",
              "PERMIT_B",
              "PERMIT_C",
              "PERMIT_L",
              "PERMIT_G",
              "PERMIT_CI",
              "PERMIT_F",
              "PERMIT_N",
              "PERMIT_S",
              "NO_PERMIT_YET",
              "OTHER"
            ]
          },
          "permitDetails": {
            "type": "string",
            "maxLength": 500
          },
          "addressSameAsMainTenant": {
            "type": "boolean"
          },
          "addressLine1": {
            "type": "string",
            "maxLength": 200
          },
          "addressLine2": {
            "type": "string",
            "maxLength": 200
          },
          "postalCode": {
            "type": "string",
            "maxLength": 30
          },
          "city": {
            "type": "string",
            "maxLength": 100
          },
          "countryCode": {
            "type": "string",
            "maxLength": 10
          },
          "isBillingRecipient": {
            "type": "boolean"
          },
          "isPrimaryTenancyContact": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "isMainTenant",
          "firstName",
          "lastName",
          "birthDate",
          "identityDocumentType",
          "passportOrIdNumber",
          "phone",
          "email",
          "nationalityCode",
          "permitStatus",
          "permitDetails",
          "addressSameAsMainTenant",
          "addressLine1",
          "addressLine2",
          "postalCode",
          "city",
          "countryCode",
          "isBillingRecipient",
          "isPrimaryTenancyContact"
        ],
        "additionalProperties": false
      }
    },
    "tenantPartyMode": {
      "type": "string",
      "enum": [
        "PRIVATE",
        "COMPANY"
      ]
    },
    "companyTenantName": {
      "type": "string",
      "maxLength": 500
    },
    "companyTenantStreetLine1": {
      "type": "string",
      "maxLength": 200
    },
    "companyTenantStreetLine2": {
      "type": "string",
      "maxLength": 200
    },
    "companyTenantPostalCode": {
      "type": "string",
      "maxLength": 30
    },
    "companyTenantCity": {
      "type": "string",
      "maxLength": 100
    },
    "companyTenantCountryCode": {
      "type": "string",
      "maxLength": 10
    },
    "companyTenantSigners": {
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "firstName": {
            "type": "string",
            "maxLength": 100
          },
          "lastName": {
            "type": "string",
            "maxLength": 100
          },
          "roleTitle": {
            "type": "string",
            "maxLength": 100
          },
          "email": {
            "anyOf": [
              {
                "type": "string",
                "const": ""
              },
              {
                "type": "string",
                "maxLength": 320,
                "format": "email",
                "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
              }
            ]
          },
          "phone": {
            "type": "string",
            "maxLength": 100
          }
        },
        "required": [
          "id",
          "firstName",
          "lastName",
          "roleTitle",
          "email",
          "phone"
        ],
        "additionalProperties": false
      }
    },
    "billingIntentType": {
      "type": "string",
      "enum": [
        "TENANT",
        "COMPANY",
        "OTHER_PRIVATE"
      ]
    },
    "billingEmail": {
      "anyOf": [
        {
          "type": "string",
          "const": ""
        },
        {
          "type": "string",
          "maxLength": 320,
          "format": "email",
          "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
        }
      ]
    },
    "billingPrivateFirstName": {
      "type": "string",
      "maxLength": 100
    },
    "billingPrivateLastName": {
      "type": "string",
      "maxLength": 100
    },
    "companyBillingName": {
      "type": "string",
      "maxLength": 500
    },
    "billingStreetLine1": {
      "type": "string",
      "maxLength": 200
    },
    "billingStreetLine2": {
      "type": "string",
      "maxLength": 200
    },
    "billingPostalCode": {
      "type": "string",
      "maxLength": 30
    },
    "billingCity": {
      "type": "string",
      "maxLength": 100
    },
    "billingCountryCode": {
      "type": "string",
      "maxLength": 10
    },
    "contractLanguageCode": {
      "type": "string",
      "enum": [
        "DE",
        "EN"
      ]
    },
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "expectedVersion",
    "sessionToken",
    "idempotencyKey"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

applications.create_document_upload

Create a 15-minute, exact-size and exact-content-type signed upload form for one email-verified application at its exact current version.

Parameters7

expectedVersion	string	required
contextKey	string	required
fileName	string	required
mimeType	string	required
sizeBytes	integer	required
sessionToken	string	required
idempotencyKey	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "expectedVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "contextKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "fileName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "mimeType": {
      "type": "string",
      "enum": [
        "application/pdf",
        "image/jpeg",
        "image/png"
      ]
    },
    "sizeBytes": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10000000
    },
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "expectedVersion",
    "contextKey",
    "fileName",
    "mimeType",
    "sizeBytes",
    "sessionToken",
    "idempotencyKey"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

applications.complete_document_upload

Verify the uploaded object, content signature, session ownership, expiry, and exact application version before creating the protected document record.

Parameters4

expectedVersion	string	required
sessionToken	string	required
uploadSessionId	string	required
idempotencyKey	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "expectedVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "uploadSessionId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "expectedVersion",
    "sessionToken",
    "uploadSessionId",
    "idempotencyKey"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

applications.upload_document

Upload one bounded PDF, JPEG, or PNG identity or company-registry document to an email-verified application using its exact version and a durable idempotency key.

Parameters8

expectedVersion	string	required
contextKey	string	required
fileName	string	required
mimeType	string	required
sizeBytes	integer	required
contentBase64	string	required
sessionToken	string	required
idempotencyKey	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "expectedVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "contextKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "fileName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "mimeType": {
      "type": "string",
      "enum": [
        "application/pdf",
        "image/jpeg",
        "image/png"
      ]
    },
    "sizeBytes": {
      "type": "integer",
      "minimum": 1,
      "maximum": 10000000
    },
    "contentBase64": {
      "type": "string",
      "minLength": 4,
      "maxLength": 14000000
    },
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "expectedVersion",
    "contextKey",
    "fileName",
    "mimeType",
    "sizeBytes",
    "contentBase64",
    "sessionToken",
    "idempotencyKey"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

applications.submit

Submit one complete email-verified application for review using its exact version, explicit current credit-check and truth-confirmation consent, and a durable idempotency key.

Parameters6

expectedVersion	string	required
creditCheckConsentAccepted	boolean	required
truthConfirmationAccepted	boolean	required
consentVersion	string	required
sessionToken	string	required
idempotencyKey	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "expectedVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "creditCheckConsentAccepted": {
      "type": "boolean",
      "const": true
    },
    "truthConfirmationAccepted": {
      "type": "boolean",
      "const": true
    },
    "consentVersion": {
      "type": "string",
      "const": "2026-07-13"
    },
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "expectedVersion",
    "creditCheckConsentAccepted",
    "truthConfirmationAccepted",
    "consentVersion",
    "sessionToken",
    "idempotencyKey"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

viewings.get_status

Read customer-safe viewing proposals and confirmed viewing state for one email-verified application session.

Parameters1

sessionToken

string

required

Raw schema

{
  "type": "object",
  "properties": {
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "sessionToken"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#"
}

viewings.propose_availability

Propose one to five bounded future viewing slots from an email-verified application at its exact version using a durable idempotency key.

Parameters4

expectedVersion	string	required
slots	array	required
sessionToken	string	required
idempotencyKey	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "expectedVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "slots": {
      "minItems": 1,
      "maxItems": 5,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "proposedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          },
          "note": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 1000
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "proposedAt"
        ],
        "additionalProperties": false
      }
    },
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "expectedVersion",
    "slots",
    "sessionToken",
    "idempotencyKey"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

viewings.respond_to_proposal

Accept or decline one pending Elron Club proposal with explicit confirmation, an exact application version, and a durable idempotency key. Acceptance may send the existing viewing confirmation communication.

Parameters6

expectedVersion	string	required
action	string	required
responseConfirmed	boolean	required
sessionToken	string	required
proposalId	string	required
idempotencyKey	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "expectedVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "action": {
      "type": "string",
      "enum": [
        "ACCEPT",
        "DECLINE"
      ]
    },
    "responseConfirmed": {
      "type": "boolean",
      "const": true
    },
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "proposalId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "expectedVersion",
    "action",
    "responseConfirmed",
    "sessionToken",
    "proposalId",
    "idempotencyKey"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

quotes.create

Snapshot customer-safe approved request terms into a 24-hour quote. The application must be submitted, internally approved, due-diligence positive, and solvency passed. This does not hold inventory.

Parameters3

expectedApplicationVersion	string	required
sessionToken	string	required
idempotencyKey	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "expectedApplicationVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "expectedApplicationVersion",
    "sessionToken",
    "idempotencyKey"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

quotes.get

Read one privacy-minimized quote and its live expiry/availability-hold state using the application session that owns it.

Parameters2

sessionToken	string	required
quoteId	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "quoteId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "sessionToken",
    "quoteId"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

quotes.accept

With explicit customer confirmation, accept one exact active quote and atomically claim a 30-minute request-owned availability hold. This does not create or sign a contract and does not authorize payment.

Parameters5

expectedQuoteVersion	string	required
acceptanceConfirmed	boolean	required
sessionToken	string	required
quoteId	string	required
idempotencyKey	string	required

Raw schema

{
  "type": "object",
  "properties": {
    "expectedQuoteVersion": {
      "type": "string",
      "format": "date-time",
      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
    },
    "acceptanceConfirmed": {
      "type": "boolean",
      "const": true
    },
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    },
    "quoteId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "expectedQuoteVersion",
    "acceptanceConfirmed",
    "sessionToken",
    "quoteId",
    "idempotencyKey"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

reservations.get_status

Read privacy-minimized hold, contract, signature, payment, reservation, or confirmation state for one application session.

Parameters1

sessionToken

string

required

Raw schema

{
  "type": "object",
  "properties": {
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "sessionToken"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

contracts.get_signing_link

Return a secure signing URL only when the active signer invitation email matches the email-verified application session. Human verification, review, and signature remain in the signing flow.

Parameters1

sessionToken

string

required

Raw schema

{
  "type": "object",
  "properties": {
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "sessionToken"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

payments.get_status

Return due and received payment truth for the scoped application. An approved human-action URL is returned only from an exact, unexpired provider session; no authorization URL is fabricated.

Parameters1

sessionToken

string

required

Raw schema

{
  "type": "object",
  "properties": {
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "sessionToken"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

bookings.get_confirmation

Return a privacy-minimized booking confirmation only after the request has converted into the authoritative Stay workflow.

Parameters1

sessionToken

string

required

Raw schema

{
  "type": "object",
  "properties": {
    "sessionToken": {
      "type": "string",
      "minLength": 1,
      "maxLength": 500
    }
  },
  "required": [
    "sessionToken"
  ],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false
}

Elron Club Public Rentals

🛠️ Key Features

🚀 Use Cases

⚡ Developer Benefits

⚠️ Limitations

rentals.search

rentals.get

rentals.check_availability

rentals.get_pricing

applications.start

applications.get_status

applications.update

applications.create_document_upload

applications.complete_document_upload

applications.upload_document

applications.submit

viewings.get_status

viewings.propose_availability

viewings.respond_to_proposal

quotes.create

quotes.get

quotes.accept

reservations.get_status

contracts.get_signing_link

payments.get_status

bookings.get_confirmation

Install

Remote endpoint