Checks whether a record exists in the All Time dataset based on query parameters.
Returns either a full record or "No records found".
Authentication
Include your API key in the header:
x-api-key: YOUR_API_KEY
Headers
| Header | Type | Required | Description |
|---|---|---|---|
x-api-key |
string | Yes | Your API key for authentication |
Content-Type |
string | Optional | Not required for GET requests |
Query Parameters (Alphabetical)
You may pass one or more of the following parameters.
Matching is case-insensitive for strings.
Dates must be in MM/DD/YYYY format.
| Parameter | Type | Required | Matching Rule |
|---|---|---|---|
agent_name |
string | Optional | Contains match |
carrier |
string | Optional | Contains match |
client_full_name |
string | Optional | Partial match, accounting for variations such as shortened names (e.g., John vs. Johnathan), presence or absence of middle names, and multi-part last names commonly found in Hispanic naming conventions. |
date |
string (MM/DD/YYYY) | Optional | Used only for tie-breaking |
policy_number |
string | Optional | Contains match against both Policy Number and Carrier Member ID |
Unknown or empty parameters are ignored.
Responses
200 OK — No Records Found
{
"message": "No records found"
}
200 OK — Matched
{
"id": "8056e2df-99ee-42d0-8dbd-a6bd57d39ae3",
"case_id": "61d39cd3-dafe-4442-b49a-59be9789f3b7",
"agent_name": "Best Agent",
"carrier": "Unitedhealthcare Med Adv",
"agent_id": "12281234",
"agent_npn": "",
"statement_date": "05/01/2025",
"payment_period": "May 2025",
"client_full_name": "Carol Jones",
"client_first_name": "Carol",
"client_middle_name": "",
"client_last_name": "Jones",
"carrier_member_id": "123456789",
"policy_number": "0987654321",
"effective_date": "10/01/2019",
"duration_months": 67,
"prior_plan": "",
"termination_date": "",
"termination_reason": "",
"line": "Health",
"sub_line": "Med Supp",
"plan_type": "Medicare Supplement",
"plan": "",
"contract": "",
"pbp": "",
"member_state": "",
"member_county": "",
"premium": "22.09",
"agent_split": "",
"comp_rate": "",
"lives": 0,
"commission": 2209,
"expected_comm": "",
"reconcile": "",
"commission_action": "Commission",
"classification": "Advance",
"agent_comp_plan": "",
"agent_payroll": 0,
"apply_payroll_to": "",
"locked": false,
"upline1_name": "",
"upline1_comp_plan": "",
"upline1_payroll": 0,
"upline2_name": "",
"upline2_comp_plan": "",
"upline2_payroll": 0,
"upline3_name": "",
"upline3_comp_plan": "",
"upline3_payroll": 0,
"upline4_name": "",
"upline4_comp_plan": "",
"upline4_payroll": 0,
"upline5_name": "",
"upline5_comp_plan": "",
"upline5_payroll": 0,
"upline6_name": "",
"upline6_comp_plan": "",
"upline6_payroll": 0,
"upline7_name": "",
"upline7_comp_plan": "",
"upline7_payroll": 0,
"your_spread": 0,
"statement_link_id": "5f34e605-b5fb-4e83-bbfb-1c0ef8418920",
"statement_link": {
"id": "00000000-0000-0000-0000-000000000000",
"case_id": "00000000-0000-0000-0000-000000000000",
"name": "",
"file_hash": "",
"created": "0001-01-01T00:00:00Z"
},
"case_name": "whatever"
}
Error Responses
| Status | Description | Example |
|---|---|---|
400 |
Invalid date format (MM/DD/YYYY required) |
{"error": "validation_error", "message": "Invalid format for 'date'."} |
401 |
Invalid or missing API key | {"error": "unauthorized"} |
429 |
Too many requests | {"error": "rate_limit_exceeded"} |
500 / 503
|
Internal or temporary error | {"error": "internal_error"} |