BranchFinder
API
v0
Production
Overview
Insurance operations including policies and claims management
- Version: 1.0
Base URL
https://connecttoazure.azure-api.net/app
Authentication
| Scheme | Type | Details |
|---|---|---|
| apiKeyHeader | apiKey | API Key in header. Parameter: Ocp-Apim-Subscription-Key |
| apiKeyQuery | apiKey | API Key in query. Parameter: subscription-key |
Endpoints
Insurance - Policies
Policy management operations
| Method | Path | Summary |
|---|---|---|
| GET | /api/insurance/policies | Get all insurance policies |
| POST | /api/insurance/policies | Create a new insurance policy |
| GET | /api/insurance/policies/{id} | Get policy by ID |
| PATCH | /api/insurance/policies/{id}/status | Update policy status |
GET /api/insurance/policies
Get all insurance policies
Responses
| Status | Description |
|---|---|
| 200 | List of policies |
POST /api/insurance/policies
Create a new insurance policy
Request Body
Optional
Content types: application/json
Schema type: object
Responses
| Status | Description |
|---|---|
| 201 | Policy created successfully |
GET /api/insurance/policies/{id}
Get policy by ID
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | Yes | string |
Responses
| Status | Description |
|---|---|
| 200 | Policy details |
PATCH /api/insurance/policies/{id}/status
Update policy status
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | Yes | string |
Request Body
Optional
Content types: application/json
Schema type: object
Responses
| Status | Description |
|---|---|
| 200 | Policy status updated |
Insurance - Claims
Claims management operations
| Method | Path | Summary |
|---|---|---|
| GET | /api/insurance/claims | Get all insurance claims |
| POST | /api/insurance/claims | Create a new insurance claim |
| PATCH | /api/insurance/claims/{id}/status | Update claim status |
| GET | /api/insurance/policies/{id}/claims | Get claims for a specific policy |
GET /api/insurance/claims
Get all insurance claims
Responses
| Status | Description |
|---|---|
| 200 | List of claims |
POST /api/insurance/claims
Create a new insurance claim
Request Body
Optional
Content types: application/json
Schema type: object
Responses
| Status | Description |
|---|---|
| 201 | Claim created successfully |
PATCH /api/insurance/claims/{id}/status
Update claim status
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | Yes | string |
Request Body
Optional
Content types: application/json
Schema type: object
Responses
| Status | Description |
|---|---|
| 200 | Claim status updated |
GET /api/insurance/policies/{id}/claims
Get claims for a specific policy
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | Yes | string |
Responses
| Status | Description |
|---|---|
| 200 | Policy claims |
Data Models
Policy
| Property | Type | Required | Description |
|---|---|---|---|
| id | string (cuid) | No | Unique identifier for the Policy |
| policyNumber | string | No | Unique policy number |
| policyType | string enum | Yes | Type of insurance policy |
| premium | number (float) | Yes | Premium amount for the policy |
| coverageAmount | number (float) | Yes | Total coverage amount of the policy |
| status | string enum | No | Current status of the policy |
| customerId | string (cuid) | Yes | ID of the customer who owns this policy |
| startDate | string (date-time) | Yes | Start date of the policy |
| endDate | string (date-time) | Yes | End date of the policy |
| createdAt | string (date-time) | No | Timestamp of when the policy was created |
| updatedAt | string (date-time) | No | Timestamp of when the policy was last updated |
Claim
| Property | Type | Required | Description |
|---|---|---|---|
| id | string (cuid) | No | Unique identifier for the Claim |
| claimNumber | string | No | Unique claim number |
| policyId | string (cuid) | Yes | ID of the policy associated with this claim |
| amount | number (float) | Yes | Amount of the claim |
| status | string enum | No | Current status of the claim |
| description | string | Yes | Description of the claim |
| createdAt | string (date-time) | No | Timestamp of when the claim was created |
| updatedAt | string (date-time) | No | Timestamp of when the claim was last updated |