Guaranty Fund Integration Guide

TECHNICAL INTEGRATION GUIDE

Guaranty Fund Integration Guide

GSI External API — UDS Data via Webhooks and REST

Audience	Guaranty Fund Technical Staff / Developers
Version	1.0
Last Updated	June 2026
Base URL	https://api.guarantysupport.com/api/v1/

Overview

This guide explains how to integrate your automated systems with the GSI API to receive UDS data as structured JSON — replacing the traditional UDS 2.0 text-file-on-FTP workflow.

The integration has two parts working in concert:

Webhook notifications — GSI pushes an event to your endpoint when new UDS data is available for your fund.
API data retrieval — Your system calls the GSI External API to pull the actual records using the batch number from the webhook payload.

Integration Flow

GSI processes a UDS batch
         │
         ▼
Webhook dispatcher sends POST to your endpoint
         │
         ▼
Your system receives the event, extracts uds_batch_number
         │
         ▼
Your system queries /api/v1/claims/, /api/v1/notes/, etc.
         │
         ▼
Your staging database is populated with UDS JSON records

Prerequisites

Before configuring the integration, confirm the following:

Your fund has an active GSI account and has been provisioned for API access.
You have received your API key from your GSI liaison.
You have a publicly accessible HTTPS endpoint that can receive POST requests (your webhook receiver).
Your endpoint returns a 200 OK within 5 seconds or GSI will treat the delivery as failed and retry.
Your network allows outbound HTTPS to api.guarantysupport.com.

Part 1: Webhook Notifications

Registering Your Endpoint

Contact your GSI liaison to register your webhook endpoint URL. GSI will configure the webhook dispatcher to send events to your endpoint whenever a new UDS batch is processed for your fund.

Provide the following to GSI:

Your HTTPS endpoint URL
Preferred event types (see Event Types below)
A contact email for delivery failure alerts

Webhook Payload Structure

GSI sends a POST request to your endpoint with a JSON body. The most important field is uds_batch_number — you will use this to retrieve the actual records via the API.

Example Webhook Payload

{
  "event_type": "uds_batch_ready",
  "fund_id": "your-fund-id",
  "uds_batch_number": "2024-001-ABC",
  "batch_date": "2024-03-15",
  "record_types": ["A", "F", "G"],
  "record_count": 142,
  "timestamp": "2024-03-15T14:23:00Z"
}

Event Types

Event Type	Triggered When
uds_batch_ready	A new UDS batch has been processed and is ready for retrieval.
uds_batch_updated	A previously delivered batch has been corrected or supplemented.
uds_batch_cancelled	A batch was cancelled before processing (e.g., duplicate submission).

⚠️ Important

Your endpoint must return 200 OK within 5 seconds. If it does not, GSI will retry delivery up to 3 times with exponential backoff. Process the webhook asynchronously — acknowledge receipt immediately, then retrieve records in a background job.

Part 2: API Data Retrieval

Authentication

All API requests must include your API key in the request header:

Authorization: Api-Key YOUR_API_KEY_HERE

Available Endpoints

Endpoint	UDS Record Type	Description
/api/v1/claims/	A Record	Open loss claims — claimant details, coverage, reserves.
/api/v1/uep/	B Record	Unearned premium policies.
/api/v1/closed-claims/	E Record	Claims already closed by the receiver.
/api/v1/notes/	F Record	Claim notes from the receiver.
/api/v1/payment-history/	G Record	Prior payment records.
/api/v1/documents/	I Record	Image index — document references and metadata.
/api/v1/msp/	M Record	Medicare Secondary Payer data.

Example Request

Use the uds_batch_number from the webhook payload as a query parameter to filter results to the specific batch:

GET /api/v1/claims/

GET https://api.guarantysupport.com/api/v1/claims/?batch=2024-001-ABC
Authorization: Api-Key YOUR_API_KEY_HERE

💡 Tip

Results are paginated. Check the next field in the response for a URL to the next page. Continue paginating until next is null.

Error Handling

HTTP Status	Meaning	Action
401	Unauthorized	Check your API key. Contact GSI if the key appears correct.
403	Forbidden	Your key does not have access to this resource. Contact your GSI liaison.
404	Not Found	Batch number not found. Verify the value from the webhook payload.
429	Rate Limited	Too many requests. Implement exponential backoff and retry.
500	Server Error	Retry after a brief delay. If persistent, contact GSI support.

Quick Reference

I want to…	Here's how
Register a webhook endpoint	Contact your GSI liaison with your HTTPS URL and preferred event types.
Get my batch number	Extract `uds_batch_number` from the webhook POST body.
Retrieve open claims	`GET /api/v1/claims/?batch={uds_batch_number}`
Retrieve claim notes	`GET /api/v1/notes/?batch={uds_batch_number}`
Handle pagination	Follow the `next` URL in each response until it returns `null`.
Authenticate my requests	Add `Authorization: Api-Key YOUR_KEY` to every request header.

Need Help?

For API access issues, webhook configuration, or integration questions, contact your GSI liaison or reach out to GSI support.