Quick Start Guide

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": {}
  }'