> ## Documentation Index
> Fetch the complete documentation index at: https://docs.theguarantors.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Changelog

> New features and changes to TheGuarantors API.

Breaking changes are announced as described in the [Breaking Change Policy](https://docs.theguarantors.com/breaking-change-policy.md).

**October 2026**

Error codes, live invite amendment webhooks and bond document links

## New features

* **Error codes on the invite amendment endpoints.** `PATCH /v1/invites/{id}`, `POST /v1/invites/{id}/invite-recipients`, `PATCH /v1/invite-recipients/{id}` and `DELETE /v1/invite-recipients/{id}` now return a machine-readable `error_code` in their error responses, except for errors raised while authenticating your request. A `validation_error` also includes `field_errors`, with the path, `code` and `message` of each rejected field. See [Error codes](https://docs.theguarantors.com/errors.md#error-codes).
* **Invite amendment webhooks for live invites.** [`invite.updated`](https://docs.theguarantors.com/application-api/invites/inviteupdated), [`invite_recipient.added`](https://docs.theguarantors.com/application-api/invites/invite_recipientadded), [`invite_recipient.updated`](https://docs.theguarantors.com/application-api/invites/invite_recipientupdated) and [`invite_recipient.removed`](https://docs.theguarantors.com/application-api/invites/invite_recipientremoved) are now sent for live invites. See [Webhooks](https://docs.theguarantors.com/webhooks.md).

## Updates

* **Bond document links.** A bond's `document_link` now returns the bond's PDF with a plain `GET`, and no API key is needed. Links are long-lived. If one stops working, fetch the bond again for a fresh link. See [Bond](https://docs.theguarantors.com/schemas/bond.md).
* **`not_started` applicant status.** An applicant's `status` is `not_started` until they start their application. Make sure your integration accepts this value. See [Applicant](https://docs.theguarantors.com/schemas/applicant.md).
* **Unknown fields are rejected.** Request bodies may only contain the fields documented for that endpoint. Any other field, at any level, returns a `400` that lists each one by its path, and nothing is created or modified. `metadata` objects still accept any keys. See [Unknown fields](https://docs.theguarantors.com/errors.md#unknown-fields).
* **Property access checks.** Requests for an invite or application on a property your API key can't access now return `404`, the same as for one that doesn't exist.

**September 2026**

Invite amendments and application cancelation

## New features

* **Invite amendments.** You can now change an invite after creating it, as long as it hasn't been canceled, expired or converted into an application. Each change sends the matching webhook. See [Amending an Invite](https://docs.theguarantors.com/amending-an-invite.md).
  * [Update an invite](https://docs.theguarantors.com/application-api/invites/update-an-invite.md)
  * [Add an invite recipient](https://docs.theguarantors.com/application-api/invites/add-an-invite-recipient.md)
  * [Update an invite recipient](https://docs.theguarantors.com/application-api/invites/update-an-invite-recipient.md)
  * [Remove an invite recipient](https://docs.theguarantors.com/application-api/invites/remove-an-invite-recipient.md)
* **Application cancelation.** [Cancel an application](https://docs.theguarantors.com/application-api/applications/cancel-an-application.md) at any point before a bond is issued, with an optional `reason` of up to 1,000 characters. You receive an [`application.status.canceled`](https://docs.theguarantors.com/application-api/applications/applicationstatuscanceled) webhook when an application is canceled, either by you or by TheGuarantors. See [Canceling an Application](https://docs.theguarantors.com/canceling-an-application.md).

## Updates

* **`expired` invite status.** An invite's `status` can now be `expired`. See [Invite](https://docs.theguarantors.com/schemas/invite.md).

**August 2026**

Invite cancelation and invite status

## New features

* **Invite cancelation.** [Cancel an invite](https://docs.theguarantors.com/application-api/invites/cancel-an-invite.md) that hasn't converted into an application. You receive an [`invite.status.canceled`](https://docs.theguarantors.com/application-api/invites/invitestatuscanceled) webhook when an invite is canceled. Canceling an invite that's already canceled returns `200` and doesn't send another webhook. See [Canceling an Invite](https://docs.theguarantors.com/amending-an-invite.md#canceling-an-invite).
* **Invite status.** Invites now include a `status` of `created`, `accepted` or `canceled`. See [Invite](https://docs.theguarantors.com/schemas/invite.md).

**June 2026**

Applicant endpoint and webhooks

## New features

* **Applicants.** [Retrieve an applicant](https://docs.theguarantors.com/application-api/applicants/retrieve-an-applicant.md) by ID, and follow each applicant's progress with the [`applicant.status.started`](https://docs.theguarantors.com/application-api/applicants/applicantstatusstarted) and [`applicant.status.submitted`](https://docs.theguarantors.com/application-api/applicants/applicantstatussubmitted) webhooks. In the sandbox, trigger them through `POST /v1/webhooks/trigger` with an `invite_recipient_id`. See [Triggering Events in Sandbox](https://docs.theguarantors.com/sandbox.md#triggering-events-in-sandbox).
