Skip to main content
POST
/
policies
/
{id}
/
validate
/
{template}
Validate Policy with Template
curl --request POST \
  --url https://sandbox.axle.insure/policies/{id}/validate/{template} \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <x-access-token>' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "maxDeductible": 500
}
'
{
  "success": true,
  "data": {
    "status": "pass",
    "summary": {
      "example-rule": "pass"
    },
    "rules": {
      "example-rule": {
        "status": "pass",
        "metadata": {},
        "message": {},
        "breakdown": {}
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.axle.insure/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-client-secret
string
header
required

Your secret API key. This will be shared with you during onboarding and should be considered sensitive - it’s a password after all! Your secret will be matched with your client ID to authenticate your requests.

Headers

​
x-client-id
string
required

Your client ID. This will be shared with you during onboarding.

​
x-destination-client-id
string

The client ID of the destination client. This is optional and only used by platform clients. See the Axle for Platforms guide for more information.

​
x-access-token
string
required

The access token required for access to the requested Account. Returned as part of Exchange Token.

Path Parameters

​
id
string
required

The unique ID of the Validation template.

Query Parameters

​
term
enum<string>

Set to renewal if you would like to receive the renewal policy information. By default it returns the current policy information (i.e. current term).

⚠️ Note If policy endpoints returns 404, it means no renewal policy is available. We recommend calling the API again without the term query parameter OR passing in term=current as a query parameter.

Available options:
current,
renewal

Body

application/json

Keys correspond to the source values defined in the template's rule inputs. When a key matches a source value, the provided value is used as the rule input instead of any value from the Ignition session metadata.

Priority order for resolving a rule input value:

  1. Value from this request body (keyed by source)
  2. Value from Ignition session metadata (keyed by source)
  3. default value defined on the template rule input

Response

​
success
boolean

Indicates whether the operation was performed successfully.

Example:

true

​
data
object