Leasing Offer Status

Here's the Leasing Offer Status documentation page in a Stripe-styled format:

The Leasing Offer Status endpoint allows you to retrieve the current statuses of multiple leasing offers from a specific provider. This provides real-time visibility into the leasing application stages, helping you track each offer's progress.

Note: To use the Leasing Offer Status API, you'll need the leasing provider's internal offer ID (leasingProviderOfferId). This ID is essential for querying the provider's system to retrieve the offer status. Make sure to store this ID after creating an offer, as it will be required for tracking and status updates. You get this ID from the leasing providers portals for offers that you already processed or you get it as a result of our Create Leasing Offer endpoint.

Endpoint

GET /v1/offers/{leasingproviderslug}/status

Parameters

• leasingproviderslug (string, required, path) The unique slug for the leasing provider, typically the provider's name in lowercase without spaces or symbols (e.g., jobrad).

• x-api-key (string, required, header) Your API key for authenticating the request. For more information on API keys, see Authentication.

• leasingProviderOfferIds (array, required, query) A comma-separated list of leasing provider offer IDs to retrieve the statuses for. Include multiple IDs to check the status of multiple offers in a single request. Note that the leasing provider offer IDs are the internal IDs of the offers, which you get from the leasing providers portals for offers that you already processed or you get it as a result of our Create Leasing Offer endpoint.

Example Value: leasingProviderOfferIds=FHA-000040,FHA-000041,FHA-000042

Response

Success Response (Status 200)

Returns a JSON array containing the statuses for each requested leasing offer.

Example Response

[
{
"leasingProviderSlug": "jobrad",
"leasingProviderOfferId": "FHA-000000",
"leasingOfferStatus": "sentToLeasingProvider"
},
{
"leasingProviderSlug": "jobrad",
"leasingProviderOfferId": "FHA-000001",
"leasingOfferStatus": "created"
},
{
"leasingProviderSlug": "jobrad",
"leasingProviderOfferId": "FHA-000002",
"leasingOfferStatus": "reviewByCustomer"
}
]

Response Fields

• leasingProviderSlug (string) The slug of the leasing provider.

• leasingProviderOfferId (string) The ID of the leasing offer as per the provider's system.

• leasingOfferStatus (string) The current status of the leasing offer. Possible values include:

• created

• sentToLeasingProvider

• reviewByCustomer

• reviewByEmployer

• reviewByLeasingProvider

• reviewsSuccessful

• canceled

Error Responses

• 400 Bad Request – Invalid or missing parameters.

{
"error": "Invalid parameters"
}

• 401 Unauthorized – API key missing or invalid.

{
"error": "API key missing or invalid"
}

• 403 Forbidden – Access denied due to insufficient permissions.

{
"error": "Access denied"
}

• 404 Not Found – Leasing provider not found.

{
"error": "Leasing provider not found"
}

Example Request

Below is a sample curl request for retrieving leasing offer statuses:

curl -X GET "https://api-base-url/v1/offers/jobrad/status?leasingProviderOfferIds=FHA-000000,FHA-000001" \
-H "x-api-key: YOUR_API_KEY"

Interactive API Console

You can also explore and test each endpoint in our OpenAPI/Swagger interactive API console, which provides a hands-on way to examine request/response details in real time.