Beagle by YRIG API Docs

API for renters insurance and related operations, providing seamless integration with property management systems.


Introduction

Authentication

Property Managers

Create a Property Manager

List Property Managers

Retrieve Property Manager Details

Tenants

Create a Tenant

List Tenants

Retrieve Tenant Details

Plans

List TLL Plans

Retrieve TLL Plan Details

Enrollments

Tenant Legal Liability Enrollment

Tenant Legal Liability Bulk Enrollment

Security Deposit Replacement Enrollment

Security Deposit Replacement Bulk Enrollment

Pet Liability Enrollment

Pet Liability Bulk Enrollment

List Enrollments

Retrieve Enrollment Details

Retrieve Enrollment Certificate

Retrieve Enrollment Agreement

Lapse Enrollment

Claims

Create Claim

Retrieve Claim Details

Update Claim

List Claims

AI Insurance Verification Tool

3rd Party Insurance Verification

Default

Beagle API Documentation

Beagle API

<p class="slate-p " >The Beagle API is organized around <strong class="slate-bold">REST</strong> principles. Our API uses resource-oriented URLs, accepts <strong class="slate-bold">JSON-encoded</strong> request bodies, and returns <strong class="slate-bold">JSON-encoded</strong> responses. Beagle supports standard HTTP methods and response codes for seamless integration with your property management systems.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Features of the Beagle API</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Resource-Oriented</strong>: Consistent and predictable URLs for managing properties, tenants, policies, claims, and reports.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Authentication</strong>: Secure access using API keys, which determine whether requests are in test mode or live mode.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Scalable Operations</strong>: Supports single and bulk operations for tenant enrollments, policy management, and claims filing.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Real-Time Validation</strong>: AI-powered verification for tenant third-party insurance compliance.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Standardized Responses</strong>: All endpoints return clear, structured responses, making error handling and integration straightforward.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Using the Beagle API</h3><p class="slate-p " >You can use the Beagle API in <strong class="slate-bold">test mode</strong>, allowing you to safely test integrations without affecting live data. The API key provided determines whether a request operates in test or live mode.</p><p class="slate-p " >The Beagle API supports <strong class="slate-bold">bulk operations</strong>, enabling efficient management of tenants and policies. For example:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Enroll multiple tenants into insurance programs in a single request.</div></li><li class="slate-li " ><div style="position:relative">Bulk verify insurance compliance for tenants with third-party policies.</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Versioning</h3><p class="slate-p " >The Beagle API evolves to better meet your needs. Each version is tailored to ensure backward compatibility while delivering improvements and new functionality. Be sure to review the documentation for updates specific to your version.</p>

 principles. Our API uses resource-oriented URLs, accepts 

 responses. Beagle supports standard HTTP methods and response codes for seamless integration with your property management systems.

, allowing you to safely test integrations without affecting live data. The API key provided determines whether a request operates in test or live mode.

, enabling efficient management of tenants and policies. For example:

The Beagle API evolves to better meet your needs. Each version is tailored to ensure backward compatibility while delivering improvements and new functionality. Be sure to review the documentation for updates specific to your version.

<p class="slate-p " >The Beagle API uses token-based authentication to secure access to its endpoints. To interact with the API, you must obtain an <strong class="slate-bold">access token</strong> by making a POST request to the <code class="slate-code">/auth/token</code> endpoint. This token authorizes your application to access protected resources and perform actions within the API.</p><p class="slate-p " ></p><h3 class="slate-h3 " >How It Works</h3><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Use your <strong class="slate-bold">Client ID</strong> and <strong class="slate-bold">Client Secret</strong> to request an access token via the <code class="slate-code">/auth/token</code> endpoint.</div></li><li class="slate-li " ><div style="position:relative">The API responds with a JSON object containing:</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">access_token</strong>: The token to include in the <code class="slate-code">Authorization</code> header of your API requests.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">expires_in</strong>: The duration (in seconds) before the token expires.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">token_type</strong>: The type of token (typically &quot;Bearer&quot;).</div></li></ol><p class="slate-p " ></p><h3 class="slate-h3 " >Notes</h3><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Authorization Header</strong>: Include the token as <code class="slate-code">Authorization: Bearer {access_token}</code> in all subsequent requests.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Expiration</strong>: Tokens expire after the specified duration (<code class="slate-code">expires_in</code>). You must request a new token before making further API calls.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Secure Credentials</strong>: Keep your client credentials and access tokens secure to prevent unauthorized access.</div></li></ul><p class="slate-p " ></p>

The Beagle API uses token-based authentication to secure access to its endpoints. To interact with the API, you must obtain an 

 endpoint. This token authorizes your application to access protected resources and perform actions within the API.

Unique identifier assigned to the client during registration.

client_id

Secret code assigned to the client during registration.

client_secret

grant_type

Token used for authorized requests to the API.

access_token

Time duration in seconds until the token expires.

expires_in

Category or type of token that is issued.

token_type

<p class="slate-p " >The <strong class="slate-bold">Create a Property Manager</strong> endpoint enables you to add property manger to your account. <code class="slate-code">Tenants</code> and <code class="slate-code">Enrollments</code> are both linked to <code class="slate-code">Property Managers</code>.</p><p class="slate-p " ></p>

 endpoint enables you to add property manger to your account. 

name

email

phone

Address line 1 of the property manager business address.

address1

Address line 2 of the property manager business address.

address2

City of the property manager business address.

city

State of the property manager business address.

state

ZIP of the property manager business address.

Header parameter used for authentication and authorization purposes.

Authorization

Unique identifier for the property manager in the response.

property_manager_id

Error code or identifier in the response.

error

Human-readable error message in the response.

message

code

Unauthorized request due to invalid or missing authentication.

<p class="slate-p " >The <strong class="slate-bold">List Property Managers</strong> endpoint enables you to retrieve a list of property managers associated with your account. You can filter results by criteria such as city, state, or ZIP code, and leverage pagination to navigate.</p><p class="slate-p " ></p>

 endpoint enables you to retrieve a list of property managers associated with your account. You can filter results by criteria such as city, state, or ZIP code, and leverage pagination to navigate.

The Authorization header parameter contains the authentication credentials required to access the API.

The city parameter allows for filtering property managers based on their city location.

The state parameter can be used to filter property managers based on the state in which they are located.

The zip parameter allows for filtering property managers based on their ZIP code.

The limit parameter determines the maximum number of results to be retrieved in a single request.

limit

The offset parameter is used for pagination to specify the starting point of the results to retrieve.

offset

property_managers

The pagination parameter includes information about the pagination of results, such as the number of pages.

pagination

List of property managers retrieved successfully

The error parameter contains an error code or identifier to help diagnose issues with the API request.

The message parameter provides a human-readable error message in case of an error during the API request.

The code parameter represents the HTTP status code returned in the API response.

<p class="slate-p " >The<strong class="slate-bold"> Retrieve Property Manager Details</strong> endpoint allows users to access specific information about a property.</p><p class="slate-p " ></p>

 endpoint allows users to access specific information about a property.

An authentication token required to verify and authorize the request for retrieving property details.

A unique identifier specifically assigned to the property manager for which details are being retrieved.

manager_id

Property Manager details retrieved successfully

Displays the specific error code or identifier related to the property retrieval process.

Provides a human-readable error message to aid in understanding any issues encountered during the property retrieval operation.

Represents the HTTP status code associated with the response for the property retrieval.

<p class="slate-p " >The <strong class="slate-bold">Create a Tenant</strong> endpoint allows you to add a tenant to the system by providing details such as their first name, last name, email, phone number, and the associated property ID. This endpoint is used to manage tenant profiles and link them to properties, ensuring information is captured and associated with the correct property.
Tenant will recieve email with a Certificate of Enrollment, property manager will recieve email with Membership Agreement.</p><p class="slate-p " ></p>

 endpoint allows you to add a tenant to the system by providing details such as their first name, last name, email, phone number, and the associated property ID. This endpoint is used to manage tenant profiles and link them to properties, ensuring information is captured and associated with the correct property.
Tenant will recieve email with a Certificate of Enrollment, property manager will recieve email with Membership Agreement.

first_name

last_name

First address line of the rental property.

Second address line of the rental property.

Identifier of the property manager associated with tenant.

Header parameter containing the authorization token for the request.

Unique identifier assigned to the tenant.

tenant_id

Error code or identifier for troubleshooting purposes.

Human-readable error message in case of an issue.

HTTP status code indicating the result of the request.

<p class="slate-p " >The <strong class="slate-bold">List Tenants</strong> endpoint retrieves a list of tenants associated with a property. You can filter the results by parameters such as <code class="slate-code">last_name</code>, <code class="slate-code">email</code>, or <code class="slate-code">property_id</code>. This endpoint provides tenant data, including unique tenant identifiers and creation status.</p><p class="slate-p " ></p><p class="slate-p " ></p>

 endpoint retrieves a list of tenants associated with a property. You can filter the results by parameters such as 

. This endpoint provides tenant data, including unique tenant identifiers and creation status.

tenants

<p class="slate-p " >The <strong class="slate-bold">Retrieve Tenant Details</strong> endpoint retrieves information about a tenant using their <code class="slate-code">tenant_id</code>. It provides the tenant&apos;s unique identifier and status.</p><p class="slate-p " ></p>

 endpoint retrieves information about a tenant using their 

. It provides the tenant's unique identifier and status.

Header parameter used for user authentication and authorization.

Unique identifier assigned to each tenant for accurate retrieval of tenant details.

The tenant's rental property first address line.

The tenant's rental property second address line.

The identifier for the property manager associated with the tenant.

The timestamp indicating when the tenant record was created.

created_at

Specific error code or identifier for troubleshooting and error handling.

Human-readable error message for better understanding of any errors encountered.

Specific HTTP status code corresponding to the response.

<p class="slate-p " >The <strong class="slate-bold">List Tenant Legal Liability Plans</strong> endpoing in the Beagle API allows users to retrieve a list of all the available tenant legal liability plans.</p><p class="slate-p " ></p><p class="slate-p " ></p>

 endpoing in the Beagle API allows users to retrieve a list of all the available tenant legal liability plans.

The authorization header for authentication.

plans

List of enrollments retrieved successfully

<p class="slate-p " >The <strong class="slate-bold">Retrieve Tenant Legal Liability Plan Details</strong> endpoint retrieves information about a plan using <code class="slate-code">plan_id</code>. </p><p class="slate-p " ></p><p class="slate-p " ></p>

Retrieve Tenant Legal Liability Plan Details

 endpoint retrieves information about a plan using 

plan_id

property_coverage_limit

liability_limit

monthly_cost

<p class="slate-p " >The <strong class="slate-bold">Tenant Legal Liability Enrollment </strong>endpoints are used to enroll tenants in tenant legal liability coverage. Each enrollment must include a tenant, property, coverage limits, and start date. Use these endpoints to manage and track the enrollment process.</p><p class="slate-p " ></p>

endpoints are used to enroll tenants in tenant legal liability coverage. Each enrollment must include a tenant, property, coverage limits, and start date. Use these endpoints to manage and track the enrollment process.

The date when the coverage starts. Format YYYY-MM-DD

start_date

Unique identifier assigned to the enrollment.

enrollment_id

A user-friendly message if an error occurs.

<p class="slate-p " >The <strong class="slate-bold">Tenant Legal Liability Bulk Enrollment</strong> endpoint enables users to enroll multiple tenants in tenant legal legal liability coverage. </p><p class="slate-p " ></p>

 endpoint enables users to enroll multiple tenants in tenant legal legal liability coverage. 

The authorization header for the request.

enrollments

The error code or identifier for identifying errors.

A human-readable error message in case of an error.

<p class="slate-p " >The <strong class="slate-bold">Security Deposit Replacement Enrollment</strong> endpoints allow users to enroll tenants in a program that replaces traditional security deposits. Enrollment requires tenant and property details, monthly rent, and the program start date. Upon successful enrollment, a unique enrollment ID is generated, and any errors are communicated through the response.</p><p class="slate-p " ></p>

 endpoints allow users to enroll tenants in a program that replaces traditional security deposits. Enrollment requires tenant and property details, monthly rent, and the program start date. Upon successful enrollment, a unique enrollment ID is generated, and any errors are communicated through the response.

Identifier of the property where the security deposit insurance is being enrolled.

property_id

rent_amount

Date when the coverage for the security deposit insurance starts. Format YYYY-MM-DD

Required header parameter for authentication and authorization purposes.

Unique identifier assigned to the enrollment in the security deposit insurance program.

Unique code or identifier for specific errors.

Detailed and human-readable message in case of errors.

Standard HTTP status code for the response.

<p class="slate-p " >The <strong class="slate-bold">Security Desposit Replacement Bulk Enroolment </strong>endpoint enables users to enroll multiple tenants in Security Deposit Insurance coverage. </p><p class="slate-p " ></p>

Security Desposit Replacement Bulk Enroolment 

endpoint enables users to enroll multiple tenants in Security Deposit Insurance coverage. 

Header containing the authorization token for authentication.

<p class="slate-p " >The <strong class="slate-bold">Pet Liability Enrollment</strong> section allows users to enroll tenants in pet liability coverage. Upon successful enrollment, users receive a unique enrollment identifier and status.</p><p class="slate-p " ></p>

 section allows users to enroll tenants in pet liability coverage. Upon successful enrollment, users receive a unique enrollment identifier and status.

Unique identifier of the tenant associated with the enrollment.

Identifier of the property where the pet resides.

Indicates the type of pet, such as Dog or Cat.

pet_type

Specifies the breed of the pet being enrolled for liability insurance.

pet_breed

Age of the pet in years at the time of enrollment.

pet_age

Specifies the start date of the insurance coverage. Format YYYY-MM-DD

The authorization token required for accessing the endpoint.

Unique identifier assigned to the enrollment for reference purposes.

Specifies the error code or identifier for troubleshooting purposes.

Provides a human-readable error message in case of an error.

Represents the HTTP status code for the response.

<p class="slate-p " >The <strong class="slate-bold">Pet Liability Bulk Enrollment</strong> section allows users to enroll multiple tenants in a pet liability insurance policy by submitting tenant, property, and pet details. </p><p class="slate-p " ></p>

 section allows users to enroll multiple tenants in a pet liability insurance policy by submitting tenant, property, and pet details. 

<p class="slate-p " >The <strong class="slate-bold">List Enrollments</strong> endpoing in the Beagle API allows users to retrieve a list of enrollments using filters such as tenant ID, property ID, insurance type, and status. </p><p class="slate-p " ></p>

 endpoing in the Beagle API allows users to retrieve a list of enrollments using filters such as tenant ID, property ID, insurance type, and status. 

Filter enrollments by property manager ID.

insurance_type

status

Filter enrollments starting on or after this date. Format YYYY-MM-DD

Sections