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

# Quick Start Guide

Make your first API call in 5 minutes. This guide helps you get up and running with TheGuarantors Embed API. It covers authentication, sandbox testing, and webhooks. The API lets you invite applicants, monitor their application status in real time, and manage the full lifecycle from invite to bond issuance.

## Before you begin

You’ll need an API key.

📩 Email [developer-support@theguarantors.com](mailto:developer-support@theguarantors.com) to get one.

You can also subscribe to webhooks for real-time event notifications.

## Authentication

TheGuarantors uses Basic Auth with an API key: send your API key as the username and leave the password blank. API keys are issued per environment, so use your sandbox key with `https://api.sandbox.theguarantors.com` and your live key with `https://api.theguarantors.com`.

See [Authentication](https://docs.theguarantors.com/authentication.md) for the header format and an example.

📩 Don’t have an API key? Email [developer-support@theguarantors.com](mailto:developer-support@theguarantors.com)

## Create your first invite

An invite is the entry point to TheGuarantors' application flow. Creating one doesn't notify your applicants. Instead, the response includes a unique `link` for each invite recipient, and you send each applicant their link so they can complete their application directly with TheGuarantors.

```sh theme={null}
curl --request POST \
  --url https://api.theguarantors.com/v1/invites \
  -u '<API_KEY>:' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "property_id": "prop_nvlbcx2e5jk0fqsf",
    "coverage_level": "high",
    "obligee": "Acme Property Management LLC",
    "lease": {
      "start_date": "2026-03-01",
      "end_date": "2027-02-28",
      "monthly_rent": 320000,
      "unit_address": {
        "line1": "123 Main St",
        "line2": "Apt 2B",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001"
      }
    },
    "invite_recipients": [
      {
        "first_name": "Jane",
        "last_name": "Doe",
        "email": "jane.doe@example.com",
        "phone_number": "+12125551234"
      },
      {
        "first_name": "John",
        "last_name": "Smith",
        "email": "john.smith@example.com",
        "phone_number": "+13475559876",
        "metadata": {}
      },
      {
        "first_name": "Alex",
        "last_name": "Johnson",
        "email": "alex.johnson@example.com",
        "phone_number": "+16465550123",
        "metadata": {}
      }
    ],
    "metadata": {}
  }'
```

Once your applicant follows their link, TheGuarantors handles the bond application and underwriting process.

Their application moves through these processes:

Started → Submitted → Approved/Denied → Bond Issued

You can subscribe to webhooks to get notified at each stage - no polling needed.

## Sandbox & Testing

Use the sandbox to build and test your integration without touching live data. The sandbox is a near mirror of production, and you can manually trigger webhook events to simulate the entire lifecycle.

See the full [Sandbox Guide](https://docs.theguarantors.com/sandbox.md) for further details.

## More APIs coming soon

`POST /v1/invites` is the first of many endpoints available through our API platform. Watch the [Changelog](https://docs.theguarantors.com/changelog.md) to stay up to date.

## Need help?

See [Contact Us](https://docs.theguarantors.com/contact-us.md) for how to reach us, request an API key or a webhook subscription, and report an issue.

📩 [developer-support@theguarantors.com](mailto:developer-support@theguarantors.com)