For the complete documentation index, see llms.txt. This page is also available as Markdown.

Endpoints

Production API URL: https://api.rentalcover.com

Production API URL: https://api.rentalcover.com

Staging API URL: https://api-staging.rentalcover.com

Authentication: Every request requires an X_API_KEY header. This is not repeated on each endpoint page. See Authentication.

  • Quote: Returns a quote based on the customer's booking details. Call this during checkout when the customer has selected a vehicle.

  • Content: Returns localised marketing copy and UI modules for a given booking reference. Use this to display the product offer and opt-out option.

  • CoverOptOut: Records whether the customer opted in or out of RentalCover coverage. Must be called for every customer who is shown the offer.

  • InstantBooking: Creates a quote and confirms the booking in a single request. Use this when you want to skip the separate Quote and Purchase steps.

  • Purchase: Confirms and books a quote. Call this after the customer accepts the quote and provides payment details.

  • Status: Returns the current status and full details of a booking by its reference. Use this to verify a purchase or check the booking state.

  • Update: Modifies a quoted or purchased protection (dates, cover amount, customer details). Requires a two-step call: preview then commit.

  • Update Customer: Updates customer personal information on an existing protection.

  • Cancel: Cancels a quoted or purchased protection. Only available before the protection start date.

  • Notification/list: Returns pending booking events created directly in RentalCover (e.g. customer-initiated changes). For partners using invoicing rather than card payment.

  • Notification/update: Acknowledges that your system has processed a notification event.

  • GetAllPurchasedPolicies: Returns a paginated list of all purchased and cancelled protection. Filtered by last-modification date.

  • GetAllCancelledPolicies: Returns a paginated list of cancelled protection. Filtered by last-modification date.

  • Invoice: Returns the invoice PDF for a confirmed booking.

Last updated

Was this helpful?