Changelog

​

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.
• Invite amendment webhooks for live invites. invite.updated, invite_recipient.added, invite_recipient.updated and invite_recipient.removed are now sent for live invites. See Webhooks.

​

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.
• 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.
• 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.
• 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.

​

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.
  • Update an invite
  • Add an invite recipient
  • Update an invite recipient
  • Remove an invite recipient
• Application cancelation. Cancel an application at any point before a bond is issued, with an optional reason of up to 1,000 characters. You receive an application.status.canceled webhook when an application is canceled, either by you or by TheGuarantors. See Canceling an Application.

​

Updates

• expired invite status. An invite’s status can now be expired. See Invite.

​

New features

• Invite cancelation. Cancel an invite that hasn’t converted into an application. You receive an invite.status.canceled 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.
• Invite status. Invites now include a status of created, accepted or canceled. See Invite.

​

New features

• Applicants. Retrieve an applicant by ID, and follow each applicant’s progress with the applicant.status.started and applicant.status.submitted webhooks. In the sandbox, trigger them through POST /v1/webhooks/trigger with an invite_recipient_id. See Triggering Events in Sandbox.