Skip to main content
applicants
object[]
required

List of Applicant entities (representing one or more tenants) that are applying for coverage.

id
string
required

Unique identifier.

Example:

"sd_01HQ8Z"

invite_id
string
required
Example:

"inv_01HQ8X"

lease
object
required

The legal contract between a property manager and the tenant. A lease agreement contains information about the property, the address and duration of the lease, and financial terms like rent amount and security deposit information. Leases map 1:1 with TheGuarantors surety bonds. A single lease can have one or more applicants.

object
string
required
Example:

"application"

property_id
string
required
Example:

"prop_01HQ7A"

status
enum<string>
required

Enum representing the current state in the application process.

Available options:
started,
approved,
denied,
canceled,
bound,
submitted,
pending
Example:

"approved"

bond_id
string | null
Example:

"bond_01HQAB"

metadata
object | null

Key-value object. Use this field to include internal references, identifiers, or any additional data that helps link this lease to your internal system. Each key must be a string, and values can be strings, numbers, booleans, or null.

obligee
string | null

The party that will be the obligee/claimant on the surety bond. This can be a limited liability company (LLC), a property management company, the property name, or the legal name of a sole proprietor owner.

Example:

"Rivermark Residential LLC"