Skip to main content
Our developer support team handles API keys, webhook subscriptions and integration questions. Reach them at developer-support@theguarantors.com.

​
Request an API key

Email developer-support@theguarantors.com with your company name and whether you’re starting in the sandbox or going live. See Authentication for how to send the key with your requests.

​
Request a webhook subscription

Email developer-support@theguarantors.com with:
  • URL: The endpoint where you want to receive webhook events
  • Event Types: The specific events you wish to subscribe to
  • Secret (optional): A secret for webhook authentication. If you don’t provide one, we’ll generate one and share it with you.
The available event types are listed in Webhooks.

​
Report an issue

Include as much of the following as you can so we can find the request on our side:
  • The environment, sandbox (api.sandbox.theguarantors.com) or live (api.theguarantors.com)
  • The method and path, such as PATCH /v1/invites/inv_abc123
  • When the request was sent, with its time zone
  • The HTTP status and the response body, including the error_code if there is one
  • The X-Request-Id response header
  • The IDs involved, such as the invite, application, applicant or bond ID
  • For webhooks, the event_id and event_type of the event
Never send your API key or your webhook secret.

​
Breaking changes

See the Breaking Change Policy for how we introduce and announce breaking changes, and the Changelog for what has shipped.