### Example Rule Request

Source: https://docs.axle.insure/guides/validate/policy-validation

A TypeScript example demonstrating the structure of a rule request for policy validation.

```typescript
{
  "rule": "insureds-match",
  "parameters": {
    "insuredNames": ["John Smith", "Jane Doe"]
  }
}
```

--------------------------------

### Property Schema Example

Source: https://docs.axle.insure/api-reference/policies/get-policy-report

Example object structure for an insured property.

```yaml
id: prp_uSdzLVpi8c76H7kl6AQ-F
type: vehicle
data:
  vin: SMTD44GN3HT812287
  model: CR-V
  year: '2017'
  make: HONDA
  use: pleasure
```

--------------------------------

### Example Rule Request

Source: https://docs.axle.insure/guides/validate/policy-validation

A TypeScript example demonstrating how to structure a rule request to validate that a policy's limitPerAccident meets the $50,000 requirement.

```typescript
{
  "rule": "property-damage-limit-per-accident",
  "input": {
    "limitPerAccident": 50000
  }
}
```

--------------------------------

### Ignition Request Example

Source: https://docs.axle.insure/api-reference/ignition/start-ignition

Example payload for initiating an Ignition session, including redirect and webhook URIs.

```json
redirectUri: https://example.com/redirect
webhookUri: https://example.com/webhook
user:
  id: usr_123456789
```

--------------------------------

### Example Rule Request

Source: https://docs.axle.insure/guides/validate/policy-validation

A TypeScript example demonstrating how to structure a rule request to verify comprehensive coverage and deductible limits for a specific vehicle.

```typescript
{

```

--------------------------------

### Coverage Schema Example

Source: https://docs.axle.insure/api-reference/policies/get-policy-report

Example object structure for insurance coverage details.

```yaml
code: BI
label: Bodily Injury
limitPerPerson: 250000
limitPerAccident: 500000
```

--------------------------------

### Example Policy Active Rule

Source: https://docs.axle.insure/guides/validate/policy-validation

An example configuration for the policy-active validation rule.

```typescript
"policy-active": {
 "status": "pass"
```

--------------------------------

### Invalid Credentials Response Example

Source: https://docs.axle.insure/openapi.yaml

Example JSON response for an unauthorized request due to mismatched credentials.

```json
message: Invalid credentials
```

--------------------------------

### Policy Coverage Example

Source: https://docs.axle.insure/api-reference/sandbox/trigger-policy-event

Example structure for policy coverage items including limits and deductibles.

```yaml
- code: BI
  label: Bodily Injury
  limitPerPerson: 250000
  limitPerAccident: 500000
  property: prp_uSdzLVpi8c76H7kl6AQ-F
- code: PD
  label: Property Damage
  limitPerAccident: 100000
  property: prp_uSdzLVpi8c76H7kl6AQ-F
- code: COMP
  label: Comprehensive
  deductible: 375
  property: prp_uSdzLVpi8c76H7kl6AQ-F
- code: COLL
  label: Collision
  deductible: 375
  property: prp_uSdzLVpi8c76H7kl6AQ-F
- code: UMBI
  label: Uninsured Bodily Injury
  limitPerPerson: 100000
  limitPerAccident: 300000
  property: prp_uSdzLVpi8c76H7kl6AQ-F
```

--------------------------------

### Third Party Schema Example

Source: https://docs.axle.insure/api-reference/policies/get-policy-report

Example object structure for a third party entity.

```yaml
name: Super Leasing Trust
type: lessor
address:
  addressLine1: Po Box 105205
  state: GA
  city: Atlanta
  postalCode: '30348'
```

--------------------------------

### Example Rule Request

Source: https://docs.axle.insure/guides/validate/policy-validation

A sample JSON payload for the vehicle-use-meets-requirements rule.

```typescript
{
"rule": "vehicle-use-meets-requirements",
"input": {
 "use": "business",
 "vin": "5FNRL38209B014050"
}
}
```

--------------------------------

### User Schema Example

Source: https://docs.axle.insure/api-reference/ignition/start-ignition

Example of the user object structure used to identify the entity associated with the Ignition session.

```json
id: usr_foqnkvhwerq7h81
firstName: John
lastName: Smith
email: john@smith.com
```

--------------------------------

### Policy Validation Rule Examples

Source: https://docs.axle.insure/guides/validate/policy-validation

Example JSON payloads for requesting the policy-created-via-credit-card validation and the corresponding response structure.

```typescript
{
  "rule": "policy-created-via-credit-card"
}
```

```typescript
"policy-created-via-credit-card": {
  "status": "pass"
}
```

--------------------------------

### Example Rule Request

Source: https://docs.axle.insure/guides/validate/policy-validation

A JSON payload structure for the properties-match rule.

```typescript
{
  "rule": "properties-match",
  "input": {
    "yearMakeModel": "2009 Honda Odyssey"
  }
}
```

--------------------------------

### Policy Data Structure

Source: https://docs.axle.insure/api-reference/policies/policy

Example of the JSON structure for policy coverage details.

```json
_jsxs(_components.span, {
 className: "line",
 children: [_jsx(_components.span, {
 style: {
 color: "#116329",
 "--shiki-dark": "#9CDCFE"
 },
 children: " \"label\""
 }), _jsx(_components.span, {
 style: {
 color: "#1F2328",
 "--shiki-dark": "#D4D4D4"
 },
 children: ": "
 }), _jsx(_components.span, {
 style: {
 color: "#0A3069",
 "--shiki-dark": "#CE9178"
 },
 children: "\"Property Damage\""
 }), _jsx(_components.span, {
 style: {
 color: "#1F2328",
 "--shiki-dark": "#D4D4D4"
 },
 children: ","
 })]
 }), "\n", _jsxs(_components.span, {
 className: "line",
 children: [_jsx(_components.span, {
 style: {
 color: "#116329",
 "--shiki-dark": "#9CDCFE"
 },
 children: " \"limitPerAccident\""
 }), _jsx(_components.span, {
 style: {
 color: "#1F2328",
 "--shiki-dark": "#D4D4D4"
 },
 children: ": "
 }), _jsx(_components.span, {
 style: {
 color: "#0550AE",
 "--shiki-dark": "#B5CEA8"
 },
 children: "100000"
 })]
 }), "\n", _jsx(_components.span, {
 className: "line",
 children: _jsx(_components.span, {
 style: {
 color: "#1F2328",
 "--shiki-dark": "#D4D4D4"
 },
 children: " },"
 })
 }), "\n", _jsx(_components.span, {
 className: "line",
 children: _jsx(_components.span, {
 style: {
 color: "#1F2328",
 "--shiki-dark": "#D4D4D4"
 },
 children: " {"
 })
 }), "\n", _jsxs(_components.span, {
 className: "line",
 children: [_jsx(_components.span, {
 style: {
 color: "#116329",
 "--shiki-dark": "#9CDCFE"
 },
 children: " \"code\""
 }), _jsx(_components.span, {
 style: {
 color: "#1F2328",
 "--shiki-dark": "#D4D4D4"
 },
 children: ": "
 }), _jsx(_components.span, {
 style: {
 color: "#0A3069",
 "--shiki-dark": "#CE9178"
 },
 children: "\"UMBI\""
 }), _jsx(_components.span, {
 style: {
 color: "#1F2328",
 "--shiki-dark": "#D4D4D4"
 },
 children: ","
 })]
 }), "\n", _jsxs(_components.span, {
 className: "line",
 children: [_jsx(_components.span, {
 style: {
 color: "#116329",
 "--shiki-dark": "#9CDCFE"
 },
 children: " \"label\""
 }), _jsx(_components.span, {
 style: {
 color: "#1F2328",
 "--shiki-dark": "#D4D4D4"
 },
 children: ": "
 }), _jsx(_components.span, {
 style: {
 color: "#0A3069",
 "--shiki-dark": "#CE9178"
 },
 children: "\"Uninsured Bodily Injury\""
 }), _jsx(_components.span, {
 style: {
 color: "#1F2328",
 "--shiki-dark": "#D4D4D4"
 },
 children: ","
 })]
 }), "\n", _jsxs(_components.span, {
 className: "line",
 children: [_jsx(_components.span, {
 style: {
 color: "#116329",
 "--shiki-dark": "#9CDCFE"
 },
 children: " \"limitPerPerson\""
 }), _jsx(_components.span, {
 style: {
 color: "#1F2328",
 "--shiki-dark": "#D4D4D4"
 },
 children: ": "
 }), _jsx(_components.span, {
 style: {
 color: "#0550AE",
 "--shiki-dark": "#B5CEA8"
 },
 children: "100000"
 }), _jsx(_components.span, {
 style: {
 color: "#1F2328",
 "--shiki-dark": "#D4D4D4"
 },
 children: ","
 })]
 }), "\n", _jsxs(_components.span, {
 className: "line",
 children: [_jsx(_components.span, {
 style: {
 color: "#116329",
 "--shiki-dark": "#9CDCFE"
 },
 children: " \"limitPerAccident\""
 }), _jsx(_components.span, {
 style: {
 color: "#1F2328",
 "--shiki-dark": "#D4D4D4"
 },
 children: ": "
 }), _jsx(_components.span, {
 style: {
 color: "#0550AE",
 "--shiki-dark": "#B5CEA8"
 },
 children: "300000"
 })]
 }), "\n", _jsx(_components.span, {
 className: "line",
 children: _jsx(_components.span, {
 style: {
 color: "#1F2328",
 "--shiki-dark": "#D4D4D4"
 },
 children: " },"
 })
 }), "\n", _jsx(_components.span, {
 className: "line",
 children: _jsx(_components.span, {
 style: {
 color: "#1F2328",
 "--shiki-dark": "#D4D4D4"
 },
 children: " {"
 })
 }), "\n", _jsxs(_components.span, {
 className: "line",
 children: [_jsx(_components.span, {
 style: {
 color: "#116329",
 "--shiki-dark": "#9CDCFE"
 },
 children: " \"code\""
 }), _jsx(_components.span, {
 style: {
 color: "#1F2328",
 "--shiki-dark": "#D4D4D4"
 },
 children: ": "
 })
```

--------------------------------

### Get Carrier Response Example

Source: https://docs.axle.insure/openapi.yaml

Example JSON response structure for a single insurance carrier lookup.

```json
success: true
data:
  id: state-farm
  name: State Farm
  domain: www.statefarm.com
  address:
    addressLine1: One State Farm Plaza
    addressLine2: null
    city: Bloomington
    state: IL
    postalCode: '61710'
    country: null
  phone: '+18007828332'
  naicCodes:
    - '25178'
    - '25143'
    - '36351'
  logoUrl: https://example.com/state-farm.svg
  modifiedAt: '2023-04-04T19:27:55.523Z'
```

--------------------------------

### Initialize Ignition with Origin Parameter

Source: https://docs.axle.insure/guides/ignition-events

Example URL for initializing an Ignition session with an origin parameter to enable Window MessageEvent communication.

```text
https://ignition.axle.insure/?origin=http://example.com
```

--------------------------------

### Get Carriers Response Example

Source: https://docs.axle.insure/openapi.yaml

Example JSON response structure for retrieving a list of supported insurance carriers.

```json
success: true
data:
  - id: state-farm
    name: State Farm
    domain: www.statefarm.com
    address:
      addressLine1: One State Farm Plaza
      addressLine2: null
      city: Bloomington
      state: IL
      postalCode: '61710'
      country: null
    phone: '+18007828332'
    naicCodes:
      - '25178'
      - '25143'
      - '36351'
    logoUrl: https://example.com/state-farm.svg
    modifiedAt: '2023-04-04T19:27:55.523Z'
  - id: progressive
    name: Progressive
    domain: www.progressive.com
    address:
      addressLine1: 6300 Wilson Mills Rd
      addressLine2: null
      city: Mayfield Village
      state: OH
      postalCode: '44143'
      country: null
    phone: '+18005551234'
    naicCodes:
      - '24260'
      - '10193'
      - '16322'
    logoUrl: https://example.com/progressive.svg
    modifiedAt: '2023-04-04T19:27:55.523Z'
```

--------------------------------

### Redirect URL Example

Source: https://docs.axle.insure/guides/ignition-events

A sample URL structure showing parameters passed upon session completion.

```text
https://example.com/insurance/redirect?status=complete&authCode=cod_LwPJhgxnjinMEPfGYc-XV&client=cli_mZj6YGXhQyQnccN97aXbq&result=link
```

--------------------------------

### POST /ignition/start

Source: https://docs.axle.insure/api-reference/ignition/start-ignition

Initiates a new Ignition session for a user.

```APIDOC
## POST /ignition/start

### Description
Starts an Ignition session and returns the necessary URI and token to host the session.

### Method
POST

### Endpoint
/ignition/start

### Parameters
#### Request Body
- **redirectUri** (string) - Optional - The URI to redirect to after the session.
- **webhookUri** (string) - Optional - The URI to receive webhook events.
- **user** (object) - Required - The user object to attach to the session.
  - **id** (string) - Required - A public, unique identifier for the user or entity.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **data** (object) - Contains session details.
  - **ignitionUri** (string) - The URL that hosts the Ignition session.
  - **ignitionToken** (string) - The unique ID for the Ignition session.

### Response Example
{
  "success": true,
  "data": {
    "ignitionToken": "ign_d83jd7n2hd75jDh6E575x",
    "ignitionUri": "https://ignition.axle.insure/?token=ign_d83jd7n2hd75jDh6E575x"
  }
}
```

--------------------------------

### Vehicle Object Example

Source: https://docs.axle.insure/api-reference/sandbox/trigger-policy-event

Example JSON structure for a Vehicle object.

```json
{
  "bodyStyle": null,
  "vin": "SMTD44GN3HT812287",
  "model": "CR-V",
  "year": "2017",
  "make": "HONDA",
  "use": "pleasure"
}
```

--------------------------------

### Insured Schema Example

Source: https://docs.axle.insure/api-reference/policies/get-policy-report

Example object structure for an insured individual.

```yaml
firstName: Armaan
lastName: Sikand
dateOfBirthYear: '1993'
licenseNo: •••••7259
licenseState: GA
dateOfBirth: null
type: primary
```

--------------------------------

### Example Rule Request

Source: https://docs.axle.insure/guides/validate/policy-validation

A sample request payload demonstrating all possible fields that can be checked for existence.

```typescript
// The below example shows all the possible fields that can be checked for existence
{
"rule": "required-policy-information-is-present",
```

--------------------------------

### Exclusion Schema Example

Source: https://docs.axle.insure/api-reference/policies/get-policy-report

Example object structure for policy exclusions.

```yaml
code: WIND
label: Wind Exclusion
```

--------------------------------

### Initiate Ignition Session with cURL

Source: https://docs.axle.insure/guides/quickstart

Use this command to authenticate with your client credentials and start an Ignition session. Ensure you replace the placeholder URIs and user ID with your actual application values.

```shellscript
curl --request POST \
 --url https://api.axle.insure/ignition \
 --header 'Content-Type: application/json' \
 --header 'x-client-id: cli_mZj6YGXhQyQnccN97aXbq' \
 --header 'x-client-secret: RZM-5BErZuChKqycbCS1O' \
 --data '{
 "redirectUri": "https://example.com/insurance/success",
 "webhookUri": "https://example.com/webhook",
 "user": {"id": "usr_123456789"}
}'
```

--------------------------------

### Configure Ignition Session Request

Source: https://docs.axle.insure/guides/ignition-events

Example of the POST request body required to initiate an Ignition session with event handling.

```shellscript
curl -X POST https://api.axle.insure/v1/ignition \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "user": {
      "id": "user_123"
    },
    "webhookUri": "https://your-app.com/webhooks/axle",
    "redirectUri": "https://your-app.com/dashboard",
    "metadata": {
      "internal_id": "order_456"
    }
  }'
```

--------------------------------

### Example Rule Configuration

Source: https://docs.axle.insure/guides/validate/policy-validation

A sample JSON-like structure representing a policy validation rule for checking active status.

```typescript
"policy-active": {
  "status":"pass",
  "metadata": {
  "isActive":" true
 }
}
```

--------------------------------

### Policy Active Rule Example

Source: https://docs.axle.insure/guides/validate/policy-validation

Example JSON structure for the policy-active rule evaluation.

```typescript
"policy-active": {
  "status": "pass",
  "metadata": {
    "isActive": true
  }
}
```

--------------------------------

### Update Template Example

Source: https://docs.axle.insure/openapi.yaml

Example request body for updating an existing validation template.

```json
displayName: Overwrite Template
rules:
- rule: policy-active
metadata:
  locationId: '123'
```

--------------------------------

### Authenticate API Request

Source: https://docs.axle.insure/guides/quickstart

Example of a command-line request using client credentials and an authorization code.

```bash
--header 'x-client-id: cli_mZj6YGXhQyQnccN97aXbq' \
--header 'x-client-secret: RZM-5BErZuChKqycbCS1O' \
--data '{
"authCode": "cod_LGUgD5ZnqWy3pThdOLUsT"
}'
```

--------------------------------

### JSON Data Structure Example

Source: https://docs.axle.insure/guides/quickstart

Example of a JSON object representing property and document details.

```json
{
  "postalCode": "30348",
  "property": "prp_uSdzLVpi8c76H7kl6AQ-F",
  "documents": [
    {
      "source": "carrier",
      "name": "Declaration Page",
      "type": ["declaration-page"],
      "url": "..."
    }
  ]
}
```

--------------------------------

### Initiate Ignition Session with cURL

Source: https://docs.axle.insure/guides/quickstart

Use this command to start an Ignition session. Ensure you replace the client ID and secret with your actual credentials.

```shellscript
curl --request POST \
 --url https://api.axle.insure/ignition \
 --header 'Content-Type: application/json' \
 --header 'x-client-id: cli_mZj6YGXhQyQnccN97aXbq' \
 --header 'x-client-secret: RZM-5BErZuChKqycbCS1O' \
 --data '{
 "redirectUri": "https://example.com/insurance/success",
 "webhookUri": "https://example.com/webhook",
 "user": {"id": "usr_123456789"}
 }'
```

--------------------------------

### Example Rule Request

Source: https://docs.axle.insure/guides/validate/policy-validation

A JSON payload demonstrating the structure for an address-match rule request.

```typescript
{
 "rule": "address-match",
 "input": {
 "address": "123 Axle St. NE, Apartment 111, Atlanta, GA 30303"
 }
}
```

--------------------------------

### Policy Validation Response Examples

Source: https://docs.axle.insure/guides/validate/policy-validation

Examples of JSON response payloads for successful and failed policy validations.

```json
{
  "status": "pass",
  "summary": {
    "policy-active": "pass",
    "rental-covered-for-collision": "pass",
  },
  "rules": {
    "policy-active":{
      "status": "pass",
      "metadata": {...},
    },
    "rental-covered-for-collision": {
      "status": "pass",
      "breakdown": {...},
      "metadata": {...}
    }
  },
  "validation": "val_abcdef123456"
}
```

```json
{
  "status": "fail",
  "summary": {
    "policy-active": "pass",
    "rental-covered-for-collision": "fail",
  },
  "rules": {
    "policy-active":{
      "status": "pass",
      "metadata": {...},
    },
    "rental-covered-for-collision": {
      "status": "fail",
      "breakdown": {...},
      "metadata": {...}
    }
  },
  "validation": "val_abcdef123456"
}
```

--------------------------------

### Example Policy Object

Source: https://docs.axle.insure/guides/completion-types

A sample JSON representation of a policy object following a manual completion process.

```json
{
  "id": "pol_GkU0pIYpq6dICHEE-def3",
  "account": "acc_jP5zq_jdtXy09ColgYARy",
  "type": "auto",
  "carrier": "Other",
  "policyNumber": "POL-2025-1234",
  "effectiveDate": "2025-02-01T00:00:00.000Z",
  "expirationDate": "2025-08-01T00:00:00.000Z",
  "premium": null,
  "address": null,
  "properties": [],
  "coverages": [],
  "insureds": [],
  "thirdParties": [],
  "documents": [
    {
      "id": "doc_mno345pqr678.pdf",
      "source": "user",
      "name": "User Uploaded Document",
      "type": ["declaration-page"],
      "url": "<signed-url>",
      "issuedDate": null,
      "effectiveDate": null,
      "createdAt": "2025-02-10T00:00:00.000Z"
    }
  ],
  "createdAt": "2025-02-10T00:00:00.000Z",
  "modifiedAt": "2025-02-10T00:00:00.000Z",
  "refreshedAt": "2025-02-10T00:00:00.000Z"
}
```

```json
{
  "id": "pol_HlV1qJZqr7eJDIFF-ghi4",
  "account": "acc_kQ6ar_keuYz10DpmhZBSz",
  "type": "auto",
  "carrier": "Other",
  "policyNumber": null,
  "effectiveDate": null,
  "expirationDate": null,
  "premium": null,
  "address": null,
  "properties": [],
  "coverages": [],
  "insureds": [],
  "thirdParties": [],
  "documents": [
    {
      "id": "doc_stu901uvw234.pdf",
      "source": "user",
      "name": "Credit Card Policy Document",
      "type": ["declaration-page"],
      "url": "<signed-url>",
      "issuedDate": null,
      "effectiveDate": null,
      "createdAt": "2025-04-01T00:00:00.000Z"
    }
  ],
  "createdAt": "2025-04-01T00:00:00.000Z",
  "modifiedAt": "2025-04-01T00:00:00.000Z",
  "refreshedAt": "2025-04-01T00:00:00.000Z"
}
```

--------------------------------

### Ignition Response Example

Source: https://docs.axle.insure/api-reference/ignition/start-ignition

Successful response containing the ignitionToken and ignitionUri for the session.

```json
success: true
data:
  ignitionToken: ign_d83jd7n2hd75jDh6E575x
  ignitionUri: >-
    https://ignition.axle.insure/?token=ign_d83jd7n2hd75jDh6E575x
```

--------------------------------

### Example Policy Object

Source: https://docs.axle.insure/guides/completion-types

A sample JSON representation of a Policy object showing the structure of fields like properties, coverages, and documents.

```json
{
  "id": "pol_FjT9oHXop5cHBGDD-abc2",
  "account": "acc_iO4yp_icsWx98BnlgXZQx",
  "type": "auto",
  "carrier": "GEICO Casualty Company",
  "policyNumber": "4461832059",
  "isActive": null,
  "effectiveDate": "2025-03-01T00:00:00.000Z",
  "expirationDate": "2025-09-01T00:00:00.000Z",
  "premium": 1250,
  "address": {
    "addressLine1": "456 Oak Ave.",
    "addressLine2": null,
    "city": "Dallas",
    "state": "Texas",
    "postalCode": "75201",
    "country": "USA"
  },
  "properties": [
    {
      "id": "prp_rStUvWxYzAbCdEfGh",
      "type": "vehicle",
      "data": {
        "bodyStyle": "SUV",
        "vin": "WDDWJ8EB4KF000000",
        "model": "Model S",
        "year": "2022",
        "make": "Tesla",
        "use": null
      }
    }
  ],
  "coverages": [
    {
      "code": "BI",
      "label": "Bodily Injury",
      "limitPerPerson": 100000,
      "limitPerAccident": 300000
    },
    {
      "code": "PD",
      "label": "Property Damage",
      "limitPerAccident": 50000
    },
    {
      "code": "COMP",
      "label": "Comprehensive",
      "deductible": 500,
      "property": "prp_rStUvWxYzAbCdEfGh"
    },
    {
      "code": "COLL",
      "label": "Collision",
      "deductible": 500,
      "property": "prp_rStUvWxYzAbCdEfGh"
    }
  ],
  "insureds": [
    {
      "type": null,
      "firstName": "Jane",
      "lastName": "Doe"
    }
  ],
  "thirdParties": [
    {
      "property": "prp_rStUvWxYzAbCdEfGh",
      "type": "lienholder",
      "name": "Super Lending Trust",
      "address": {
        "addressLine1": "PO Box 71083",
        "addressLine2": null,
        "city": "Charlotte",
        "state": "NC",
        "postalCode": "28272",
        "country": null
      }
    }
  ],
  "documents": [
    {
      "id": "doc_ghi789jkl012.pdf",
      "source": "user",
      "name": "Declaration Page",
      "type": ["declaration-page"],
      "url": "<signed-url>",
      "issuedDate": null,
      "effectiveDate": null,
      "createdAt": "2025-03-05T00:00:00.000Z"
    }
  ],
  "createdAt": "2025-03-05T00:00:00.000Z",
  "modifiedAt": "2025-03-05T00:00:00.000Z",
  "refreshedAt": "2025-03-05T00:00:00.000Z"
}
```

```json
{
  "id": "pol_ImW2rKArS8fKEJGG-jkl5",
  "account": "acc_lR7bs_lfvZA21EqniACTa",
  "type": "auto",
  "carrier": "Other",
  "policyNumber": null,
  "effectiveDate": null,
  "expirationDate": null,
  "premium": null,
  "address": null,
  "properties": [],
  "coverages": [],
  "insureds": [],
  "thirdParties": [],
  "documents": [
    {
      "id": "doc_xyz567abc890.png",
      "source": "user",
      "name": "User Uploaded Document",
      "type": ["declaration-page"],
      "url": "<signed-url>",
      "issuedDate": null,
      "effectiveDate": null,
      "createdAt": "2025-05-01T00:00:00.000Z"
    }
  ],
  "createdAt": "2025-05-01T00:00:00.000Z",
  "modifiedAt": "2025-05-01T00:00:00.000Z",
  "refreshedAt": "2025-05-01T00:00:00.000Z"
}
```

--------------------------------

### Create Template Example

Source: https://docs.axle.insure/openapi.yaml

Example request body for creating a new validation template with specific rules and metadata.

```json
displayName: Example Template
rules:
- rule: policy-active
- rule: collision-coverage-meets-requirements
  input:
    deductible:
      source: maxDeductible
      default: 500
metadata:
  locationId: '123'
```

--------------------------------

### API Environment Base URLs

Source: https://docs.axle.insure/api-reference/overview

Base URLs for production and sandbox environments.

```bash
https://api.axle.insure
```

```bash
https://sandbox.axle.insure
```

--------------------------------

### Get Clients OpenAPI Definition

Source: https://docs.axle.insure/api-reference/platform/get-clients

The OpenAPI specification for the GET /platform/clients endpoint, including parameters and response schemas.

```yaml
openapi: 3.0.0
info:
  title: Axle API
  contact: {}
  version: '0.1'
servers:
  - description: Sandbox
    url: https://sandbox.axle.insure
  - description: Production
    url: https://api.axle.insure
    variables: {}
security:
  - ApiKeyAuth: []
paths:
  /platform/clients:
    get:
      tags:
        - Clients
      summary: Get Clients
      description: >-
        Get a list of destination clients associated with your platform client.
        This request will return a list of destination client `id`s that you can
        use to make requests to the Axle API on behalf of your destination
        clients.


        See the [Axle for Platforms](/guides/platform-integration) guide for
        more information on how to use this endpoint and the destination client
        `id`.
      operationId: GetDestinationClients
      parameters:
        - $ref: '#/components/parameters/x-client-id'
        - $ref: '#/components/parameters/expand'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    $ref: '#/components/schemas/Success'
                  data:
                    type: array
                    description: >-
                      A list of identifiers for the destination clients
                      associated with your credential, or if `expand=true`, a
                      list of the destination client `id` and `entity` fields.
                    items:
                      oneOf:
                        - type: string
                        - $ref: '#/components/schemas/DestinationClient'
        '400':
          $ref: '#/components/responses/InputValidation'
        '401':
          description: The `x-client-secret` provided does not match the `x-client-id`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials
        '429':
          $ref: '#/components/responses/TooManyRequests'
      deprecated: false
components:
  parameters:
    x-client-id:
      name: x-client-id
      in: header
      required: true
      schema:
        type: string
      description: Your client ID. This will be shared with you during onboarding.
    expand:
      name: expand
      in: query
      required: false
      schema:
        type: string
        enum:
          - 'true'
          - 'false'
      description: >-
        Set to `true` if you would like to expand related entities (e.g.,
        account, policy, client). Defaults to `false`.
  schemas:
    Success:
      title: Success
      type: boolean
      description: Indicates whether the operation was performed successfully.
      x-internal: false
      example: true
    DestinationClient:
      title: DestinationClient
      type: object
      properties:
        id:
          type: string
          description: >-
            The unique identifier of the destination client. You'll use this to
            make requests to the Axle API on behalf of your destination client.
        entity:
          $ref: '#/components/schemas/ClientEntity'
      required:
        - id
        - entity
    ClientEntity:
      title: ClientEntity
      type: string
      description: >-
        A standardized entity name for the destination client using all
        lowercase, and dashes instead of spaces. For example,
        `yourPlatform-${yourCustomerId}`. Entity names must be unique across all
        destination clients, and you will recieve a 409 response with a clear
        status message if the entity name has already been taken.
```

--------------------------------

### Properties Match Rule Example

Source: https://docs.axle.insure/guides/validate/policy-validation

Request and response format for validating vehicle properties using year, make, and model.

```json
{
  "rule": "properties-match",
  "input": {
      "yearMakeModel": "2009 Honda Odyssey"
  }
}
```

```json
"properties-match": {
    "status": "pass",
    "metadata": {
      "pass": [
        {
          "type": "vehicle",
          "data": {
            "bodyStyle": "minivan",
            "vin": "5FNRL38209B014050",
            "model": "Odyssey",
            "year": "2009",
            "make": "Honda"
          },
          "id": "prp_tmGUxLpgHjmW9r6M6WjhS"
        }
      ],
      "fail": [],
      "caution": [],
      "unknown": []
    }
}
```

--------------------------------

### Get Templates OpenAPI Specification

Source: https://docs.axle.insure/api-reference/validation/templates/get-templates

Defines the GET /validation/templates endpoint, including required headers and response schemas for validation configurations.

```yaml
openapi: 3.0.0
info:
  title: Axle API
  contact: {}
  version: '0.1'
servers:
  - description: Sandbox
    url: https://sandbox.axle.insure
  - description: Production
    url: https://api.axle.insure
    variables: {}
security:
  - ApiKeyAuth: []
paths:
  /validation/templates:
    get:
      tags:
        - Templates
      summary: Get Templates
      description: >-
        Get a list of all templates for the provided `clientId` or
        `destinationId`.


        Refer to the [Policy Validation with
        Templates](/guides/validate/policy-validation#validation-templates)
        guide for more details.
      operationId: GetTemplates
      parameters:
        - $ref: '#/components/parameters/x-client-id'
        - $ref: '#/components/parameters/x-destination-client-id'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    $ref: '#/components/schemas/Success'
                  data:
                    type: array
                    description: List of Validation Templates for client.
                    items:
                      $ref: '#/components/schemas/ValidationConfig'
        '400':
          $ref: '#/components/responses/InputValidation'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      deprecated: false
components:
  parameters:
    x-client-id:
      name: x-client-id
      in: header
      required: true
      schema:
        type: string
      description: Your client ID. This will be shared with you during onboarding.
    x-destination-client-id:
      name: x-destination-client-id
      in: header
      required: false
      schema:
        type: string
      description: >-
        The client ID of the destination client. This is optional and only used
        by platform clients. See the [Axle for
        Platforms](/guides/platform-integration) guide for more information.
  schemas:
    Success:
      title: Success
      type: boolean
      description: Indicates whether the operation was performed successfully.
      x-internal: false
      example: true
    ValidationConfig:
      title: ValidationConfig
      type: object
      example:
        id: tem_jsK9vrCIfABlCW7PqIknc
        displayName: Example Template
        createdAt: '2025-06-10T13:57:22.300Z'
        modifiedAt: '2025-06-10T13:57:22.300Z'
        rules:
          - rule: policy-active
          - rule: collision-coverage-meets-requirements
            input:
              deductible:
                source: maxDeductible
                default: '500'
        metadata:
          locationId: '123'
      properties:
        id:
          type: string
          description: >-
            The unqiue identifier of the Validation template. You'll use this to
            make requests to the [Validate Policy with
            Template](/api-reference/validation/templates/validate-policy-template)
            endpoint.
        displayName:
          type: string
          description: User friendly name of the template.
        createdAt:
          type: string
          description: ISO 8601 timestamp at which the Validation template was created.
        modifiedAt:
          type: string
          description: >-
            ISO 8601 timestamp at which the Validation template was last
            modified.
        rules:
          type: array
          description: List of rules to be evaluated against the Policy object.
          items:
            oneOf:
              - $ref: '#/components/schemas/RuleTemplateWithNoInput'
              - $ref: '#/components/schemas/RuleTemplateWithInput'
        metadata:
          type: object
          description: >-
            Custom information stored on the template, if provided when the
            template was created or updated via [Create
            Template](/api-reference/validation/templates/create-template),
            [Create Platform
            Template](/api-reference/platform/create-templates), or [Update
            Template](/api-reference/validation/templates/update-template).
      required:
        - id
        - displayName
        - rules
        - createdAt
        - modifiedAt
    RuleTemplateWithNoInput:
      title: Rule With No Input
      type: object
      properties:
        rule:
          type: string
          enum:
            - policy-active
            - rental-covered-for-collision
```

--------------------------------

### Get Carriers OpenAPI Specification

Source: https://docs.axle.insure/api-reference/carriers/get-carriers

Defines the GET /carriers endpoint, including required headers and the structure of the returned carrier objects.

```yaml
openapi: 3.0.0
info:
  title: Axle API
  contact: {}
  version: '0.1'
servers:
  - description: Sandbox
    url: https://sandbox.axle.insure
  - description: Production
    url: https://api.axle.insure
    variables: {}
security:
  - ApiKeyAuth: []
paths:
  /carriers:
    get:
      tags:
        - Carriers
      summary: Get Carriers
      description: >-
        The Get Carriers endpoint returns an array of Carrier objects which
        include additional details about Axle-supported insurance carriers.
      operationId: GetCarriers
      parameters:
        - $ref: '#/components/parameters/x-client-id'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    $ref: '#/components/schemas/Success'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Carrier'
              example:
                success: true
                data:
                  - id: state-farm
                    name: State Farm
                    domain: www.statefarm.com
                    address:
                      addressLine1: One State Farm Plaza
                      addressLine2: null
                      city: Bloomington
                      state: IL
                      postalCode: '61710'
                      country: null
                    phone: '+18007828332'
                    naicCodes:
                      - '25178'
                      - '25143'
                      - '36351'
                    logoUrl: https://example.com/state-farm.svg
                    modifiedAt: '2023-04-04T19:27:55.523Z'
                  - id: progressive
                    name: Progressive
                    domain: www.progressive.com
                    address:
                      addressLine1: 6300 Wilson Mills Rd
                      addressLine2: null
                      city: Mayfield Village
                      state: OH
                      postalCode: '44143'
                      country: null
                    phone: '+18005551234'
                    naicCodes:
                      - '24260'
                      - '10193'
                      - '16322'
                    logoUrl: https://example.com/progressive.svg
                    modifiedAt: '2023-04-04T19:27:55.523Z'
        '400':
          $ref: '#/components/responses/InputValidation'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      deprecated: false
components:
  parameters:
    x-client-id:
      name: x-client-id
      in: header
      required: true
      schema:
        type: string
      description: Your client ID. This will be shared with you during onboarding.
  schemas:
    Success:
      title: Success
      type: boolean
      description: Indicates whether the operation was performed successfully.
      x-internal: false
      example: true
    Carrier:
      title: Carrier
      type: object
      x-examples:
        example-1:
          id: state-farm
          name: State Farm
          domain: www.statefarm.com
          address:
            addressLine1: One State Farm Plaza
            addressLine2: null
            city: Bloomington
            state: IL
            postalCode: '61710'
            country: null
          phone: '+18007828332'
          naicCodes:
            - '25178'
            - '25143'
            - '36351'
          logoUrl: https://example.com/state-farm.svg
          modifiedAt: '2023-04-04T19:27:55.523Z'
      x-internal: false
      properties:
        id:
          type: string
        name:
          type: string
        domain:
          type: string
        address:
          $ref: '#/components/schemas/Address'
        phone:
          type: string
        naicCodes:
          type: array
          description: >-
            List of NAIC (National Association of Insurance Commissioners) codes
            associated with the carrier and its subsidiaries.
          items:
            type: string
        logoUrl:
          type: string
        modifiedAt:
          type: string
      required:
        - id
        - name
        - domain
        - address
        - phone
        - modifiedAt
    Address:
      title: Address
      type: object
      example:
        addressLine1: 123 Fake St.
        addressLine2: Unit 456
        city: Atlanta
        state: Georgia
        postalCode: '30315'
        country: USA
      x-internal: false
```

--------------------------------

### Example Rule Request

Source: https://docs.axle.insure/guides/validate/policy-validation

A sample JSON request body for validating that a policy has property damage coverage with a limit of at least $50,000.

```json
{
  "rule": "property-damage-limit-per-accident-comparison",
  "input": {
    "limitPerAccident": 50000
  }
}
```

--------------------------------

### Example Rule Request

Source: https://docs.axle.insure/guides/validate/policy-validation

A sample JSON payload for requesting a policy validation rule check.

```typescript
{
 rule: "uninsured-underinsured-pd-coverage-meets-requirements",
 input: {
 limitPerAccident: 50000
 }
}
```