Trigger Policy event
curl --request POST \
--url https://sandbox.axle.insure/sandbox/policies/{id}/event \
--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 '
{
"type": "auto",
"carrier": "state-farm",
"policyNumber": "123456789",
"isActive": true,
"effectiveDate": "2022-10-22T04:00:00.000Z",
"expirationDate": "2023-10-22T04:00:00.000Z",
"premium": 999.99,
"address": {
"addressLine1": "123 Fake St.",
"addressLine2": "Unit 456",
"city": "Atlanta",
"state": "Georgia",
"postalCode": "30315",
"country": "USA"
},
"coverages": [
{
"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"
}
],
"exclusions": [
{
"code": "WIND",
"label": "Wind Exclusion"
}
],
"properties": [
{
"id": "prp_uSdzLVpi8c76H7kl6AQ-F",
"type": "vehicle",
"data": {
"vin": "SMTD44GN3HT812287",
"model": "CR-V",
"year": "2017",
"make": "HONDA",
"use": "pleasure"
}
}
],
"insureds": [
{
"firstName": "Armaan",
"lastName": "Sikand",
"dateOfBirthYear": "1993",
"licenseNo": "•••••7259",
"licenseState": "GA",
"dateOfBirth": null,
"type": "primary"
}
],
"thirdParties": [
{
"name": "Super Leasing Trust",
"type": "lessor",
"address": {
"addressLine1": "Po Box 105205",
"state": "GA",
"city": "Atlanta",
"postalCode": "30348"
}
}
],
"documents": [
{
"source": "carrier",
"name": "Declaration Page",
"type": [
"declaration-page"
],
"url": "<signed-url>",
"id": "doc_jd73dw6fn02sj28.pdf",
"issuedDate": "2022-01-01T00:00:00.000Z",
"effectiveDate": "2022-01-02T00:00:00.000Z",
"createdAt": "2022-01-01T00:00:00.000Z"
}
]
}
'import requests
url = "https://sandbox.axle.insure/sandbox/policies/{id}/event"
payload = {
"type": "auto",
"carrier": "state-farm",
"policyNumber": "123456789",
"isActive": True,
"effectiveDate": "2022-10-22T04:00:00.000Z",
"expirationDate": "2023-10-22T04:00:00.000Z",
"premium": 999.99,
"address": {
"addressLine1": "123 Fake St.",
"addressLine2": "Unit 456",
"city": "Atlanta",
"state": "Georgia",
"postalCode": "30315",
"country": "USA"
},
"coverages": [
{
"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"
}
],
"exclusions": [
{
"code": "WIND",
"label": "Wind Exclusion"
}
],
"properties": [
{
"id": "prp_uSdzLVpi8c76H7kl6AQ-F",
"type": "vehicle",
"data": {
"vin": "SMTD44GN3HT812287",
"model": "CR-V",
"year": "2017",
"make": "HONDA",
"use": "pleasure"
}
}
],
"insureds": [
{
"firstName": "Armaan",
"lastName": "Sikand",
"dateOfBirthYear": "1993",
"licenseNo": "•••••7259",
"licenseState": "GA",
"dateOfBirth": None,
"type": "primary"
}
],
"thirdParties": [
{
"name": "Super Leasing Trust",
"type": "lessor",
"address": {
"addressLine1": "Po Box 105205",
"state": "GA",
"city": "Atlanta",
"postalCode": "30348"
}
}
],
"documents": [
{
"source": "carrier",
"name": "Declaration Page",
"type": ["declaration-page"],
"url": "<signed-url>",
"id": "doc_jd73dw6fn02sj28.pdf",
"issuedDate": "2022-01-01T00:00:00.000Z",
"effectiveDate": "2022-01-02T00:00:00.000Z",
"createdAt": "2022-01-01T00:00:00.000Z"
}
]
}
headers = {
"x-client-id": "<x-client-id>",
"x-access-token": "<x-access-token>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-id': '<x-client-id>',
'x-access-token': '<x-access-token>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 'auto',
carrier: 'state-farm',
policyNumber: '123456789',
isActive: true,
effectiveDate: '2022-10-22T04:00:00.000Z',
expirationDate: '2023-10-22T04:00:00.000Z',
premium: 999.99,
address: {
addressLine1: '123 Fake St.',
addressLine2: 'Unit 456',
city: 'Atlanta',
state: 'Georgia',
postalCode: '30315',
country: 'USA'
},
coverages: [
{
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'
}
],
exclusions: [{code: 'WIND', label: 'Wind Exclusion'}],
properties: [
{
id: 'prp_uSdzLVpi8c76H7kl6AQ-F',
type: 'vehicle',
data: {
vin: 'SMTD44GN3HT812287',
model: 'CR-V',
year: '2017',
make: 'HONDA',
use: 'pleasure'
}
}
],
insureds: [
{
firstName: 'Armaan',
lastName: 'Sikand',
dateOfBirthYear: '1993',
licenseNo: '•••••7259',
licenseState: 'GA',
dateOfBirth: null,
type: 'primary'
}
],
thirdParties: [
{
name: 'Super Leasing Trust',
type: 'lessor',
address: {
addressLine1: 'Po Box 105205',
state: 'GA',
city: 'Atlanta',
postalCode: '30348'
}
}
],
documents: [
{
source: 'carrier',
name: 'Declaration Page',
type: ['declaration-page'],
url: '<signed-url>',
id: 'doc_jd73dw6fn02sj28.pdf',
issuedDate: '2022-01-01T00:00:00.000Z',
effectiveDate: '2022-01-02T00:00:00.000Z',
createdAt: '2022-01-01T00:00:00.000Z'
}
]
})
};
fetch('https://sandbox.axle.insure/sandbox/policies/{id}/event', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.axle.insure/sandbox/policies/{id}/event",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'auto',
'carrier' => 'state-farm',
'policyNumber' => '123456789',
'isActive' => true,
'effectiveDate' => '2022-10-22T04:00:00.000Z',
'expirationDate' => '2023-10-22T04:00:00.000Z',
'premium' => 999.99,
'address' => [
'addressLine1' => '123 Fake St.',
'addressLine2' => 'Unit 456',
'city' => 'Atlanta',
'state' => 'Georgia',
'postalCode' => '30315',
'country' => 'USA'
],
'coverages' => [
[
'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'
]
],
'exclusions' => [
[
'code' => 'WIND',
'label' => 'Wind Exclusion'
]
],
'properties' => [
[
'id' => 'prp_uSdzLVpi8c76H7kl6AQ-F',
'type' => 'vehicle',
'data' => [
'vin' => 'SMTD44GN3HT812287',
'model' => 'CR-V',
'year' => '2017',
'make' => 'HONDA',
'use' => 'pleasure'
]
]
],
'insureds' => [
[
'firstName' => 'Armaan',
'lastName' => 'Sikand',
'dateOfBirthYear' => '1993',
'licenseNo' => '•••••7259',
'licenseState' => 'GA',
'dateOfBirth' => null,
'type' => 'primary'
]
],
'thirdParties' => [
[
'name' => 'Super Leasing Trust',
'type' => 'lessor',
'address' => [
'addressLine1' => 'Po Box 105205',
'state' => 'GA',
'city' => 'Atlanta',
'postalCode' => '30348'
]
]
],
'documents' => [
[
'source' => 'carrier',
'name' => 'Declaration Page',
'type' => [
'declaration-page'
],
'url' => '<signed-url>',
'id' => 'doc_jd73dw6fn02sj28.pdf',
'issuedDate' => '2022-01-01T00:00:00.000Z',
'effectiveDate' => '2022-01-02T00:00:00.000Z',
'createdAt' => '2022-01-01T00:00:00.000Z'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <x-access-token>",
"x-client-id: <x-client-id>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.axle.insure/sandbox/policies/{id}/event"
payload := strings.NewReader("{\n \"type\": \"auto\",\n \"carrier\": \"state-farm\",\n \"policyNumber\": \"123456789\",\n \"isActive\": true,\n \"effectiveDate\": \"2022-10-22T04:00:00.000Z\",\n \"expirationDate\": \"2023-10-22T04:00:00.000Z\",\n \"premium\": 999.99,\n \"address\": {\n \"addressLine1\": \"123 Fake St.\",\n \"addressLine2\": \"Unit 456\",\n \"city\": \"Atlanta\",\n \"state\": \"Georgia\",\n \"postalCode\": \"30315\",\n \"country\": \"USA\"\n },\n \"coverages\": [\n {\n \"code\": \"BI\",\n \"label\": \"Bodily Injury\",\n \"limitPerPerson\": 250000,\n \"limitPerAccident\": 500000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"PD\",\n \"label\": \"Property Damage\",\n \"limitPerAccident\": 100000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"COMP\",\n \"label\": \"Comprehensive\",\n \"deductible\": 375,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"COLL\",\n \"label\": \"Collision\",\n \"deductible\": 375,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"UMBI\",\n \"label\": \"Uninsured Bodily Injury\",\n \"limitPerPerson\": 100000,\n \"limitPerAccident\": 300000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n }\n ],\n \"exclusions\": [\n {\n \"code\": \"WIND\",\n \"label\": \"Wind Exclusion\"\n }\n ],\n \"properties\": [\n {\n \"id\": \"prp_uSdzLVpi8c76H7kl6AQ-F\",\n \"type\": \"vehicle\",\n \"data\": {\n \"vin\": \"SMTD44GN3HT812287\",\n \"model\": \"CR-V\",\n \"year\": \"2017\",\n \"make\": \"HONDA\",\n \"use\": \"pleasure\"\n }\n }\n ],\n \"insureds\": [\n {\n \"firstName\": \"Armaan\",\n \"lastName\": \"Sikand\",\n \"dateOfBirthYear\": \"1993\",\n \"licenseNo\": \"•••••7259\",\n \"licenseState\": \"GA\",\n \"dateOfBirth\": null,\n \"type\": \"primary\"\n }\n ],\n \"thirdParties\": [\n {\n \"name\": \"Super Leasing Trust\",\n \"type\": \"lessor\",\n \"address\": {\n \"addressLine1\": \"Po Box 105205\",\n \"state\": \"GA\",\n \"city\": \"Atlanta\",\n \"postalCode\": \"30348\"\n }\n }\n ],\n \"documents\": [\n {\n \"source\": \"carrier\",\n \"name\": \"Declaration Page\",\n \"type\": [\n \"declaration-page\"\n ],\n \"url\": \"<signed-url>\",\n \"id\": \"doc_jd73dw6fn02sj28.pdf\",\n \"issuedDate\": \"2022-01-01T00:00:00.000Z\",\n \"effectiveDate\": \"2022-01-02T00:00:00.000Z\",\n \"createdAt\": \"2022-01-01T00:00:00.000Z\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-id", "<x-client-id>")
req.Header.Add("x-access-token", "<x-access-token>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.axle.insure/sandbox/policies/{id}/event")
.header("x-client-id", "<x-client-id>")
.header("x-access-token", "<x-access-token>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"auto\",\n \"carrier\": \"state-farm\",\n \"policyNumber\": \"123456789\",\n \"isActive\": true,\n \"effectiveDate\": \"2022-10-22T04:00:00.000Z\",\n \"expirationDate\": \"2023-10-22T04:00:00.000Z\",\n \"premium\": 999.99,\n \"address\": {\n \"addressLine1\": \"123 Fake St.\",\n \"addressLine2\": \"Unit 456\",\n \"city\": \"Atlanta\",\n \"state\": \"Georgia\",\n \"postalCode\": \"30315\",\n \"country\": \"USA\"\n },\n \"coverages\": [\n {\n \"code\": \"BI\",\n \"label\": \"Bodily Injury\",\n \"limitPerPerson\": 250000,\n \"limitPerAccident\": 500000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"PD\",\n \"label\": \"Property Damage\",\n \"limitPerAccident\": 100000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"COMP\",\n \"label\": \"Comprehensive\",\n \"deductible\": 375,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"COLL\",\n \"label\": \"Collision\",\n \"deductible\": 375,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"UMBI\",\n \"label\": \"Uninsured Bodily Injury\",\n \"limitPerPerson\": 100000,\n \"limitPerAccident\": 300000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n }\n ],\n \"exclusions\": [\n {\n \"code\": \"WIND\",\n \"label\": \"Wind Exclusion\"\n }\n ],\n \"properties\": [\n {\n \"id\": \"prp_uSdzLVpi8c76H7kl6AQ-F\",\n \"type\": \"vehicle\",\n \"data\": {\n \"vin\": \"SMTD44GN3HT812287\",\n \"model\": \"CR-V\",\n \"year\": \"2017\",\n \"make\": \"HONDA\",\n \"use\": \"pleasure\"\n }\n }\n ],\n \"insureds\": [\n {\n \"firstName\": \"Armaan\",\n \"lastName\": \"Sikand\",\n \"dateOfBirthYear\": \"1993\",\n \"licenseNo\": \"•••••7259\",\n \"licenseState\": \"GA\",\n \"dateOfBirth\": null,\n \"type\": \"primary\"\n }\n ],\n \"thirdParties\": [\n {\n \"name\": \"Super Leasing Trust\",\n \"type\": \"lessor\",\n \"address\": {\n \"addressLine1\": \"Po Box 105205\",\n \"state\": \"GA\",\n \"city\": \"Atlanta\",\n \"postalCode\": \"30348\"\n }\n }\n ],\n \"documents\": [\n {\n \"source\": \"carrier\",\n \"name\": \"Declaration Page\",\n \"type\": [\n \"declaration-page\"\n ],\n \"url\": \"<signed-url>\",\n \"id\": \"doc_jd73dw6fn02sj28.pdf\",\n \"issuedDate\": \"2022-01-01T00:00:00.000Z\",\n \"effectiveDate\": \"2022-01-02T00:00:00.000Z\",\n \"createdAt\": \"2022-01-01T00:00:00.000Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.axle.insure/sandbox/policies/{id}/event")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<x-client-id>'
request["x-access-token"] = '<x-access-token>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"auto\",\n \"carrier\": \"state-farm\",\n \"policyNumber\": \"123456789\",\n \"isActive\": true,\n \"effectiveDate\": \"2022-10-22T04:00:00.000Z\",\n \"expirationDate\": \"2023-10-22T04:00:00.000Z\",\n \"premium\": 999.99,\n \"address\": {\n \"addressLine1\": \"123 Fake St.\",\n \"addressLine2\": \"Unit 456\",\n \"city\": \"Atlanta\",\n \"state\": \"Georgia\",\n \"postalCode\": \"30315\",\n \"country\": \"USA\"\n },\n \"coverages\": [\n {\n \"code\": \"BI\",\n \"label\": \"Bodily Injury\",\n \"limitPerPerson\": 250000,\n \"limitPerAccident\": 500000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"PD\",\n \"label\": \"Property Damage\",\n \"limitPerAccident\": 100000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"COMP\",\n \"label\": \"Comprehensive\",\n \"deductible\": 375,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"COLL\",\n \"label\": \"Collision\",\n \"deductible\": 375,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"UMBI\",\n \"label\": \"Uninsured Bodily Injury\",\n \"limitPerPerson\": 100000,\n \"limitPerAccident\": 300000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n }\n ],\n \"exclusions\": [\n {\n \"code\": \"WIND\",\n \"label\": \"Wind Exclusion\"\n }\n ],\n \"properties\": [\n {\n \"id\": \"prp_uSdzLVpi8c76H7kl6AQ-F\",\n \"type\": \"vehicle\",\n \"data\": {\n \"vin\": \"SMTD44GN3HT812287\",\n \"model\": \"CR-V\",\n \"year\": \"2017\",\n \"make\": \"HONDA\",\n \"use\": \"pleasure\"\n }\n }\n ],\n \"insureds\": [\n {\n \"firstName\": \"Armaan\",\n \"lastName\": \"Sikand\",\n \"dateOfBirthYear\": \"1993\",\n \"licenseNo\": \"•••••7259\",\n \"licenseState\": \"GA\",\n \"dateOfBirth\": null,\n \"type\": \"primary\"\n }\n ],\n \"thirdParties\": [\n {\n \"name\": \"Super Leasing Trust\",\n \"type\": \"lessor\",\n \"address\": {\n \"addressLine1\": \"Po Box 105205\",\n \"state\": \"GA\",\n \"city\": \"Atlanta\",\n \"postalCode\": \"30348\"\n }\n }\n ],\n \"documents\": [\n {\n \"source\": \"carrier\",\n \"name\": \"Declaration Page\",\n \"type\": [\n \"declaration-page\"\n ],\n \"url\": \"<signed-url>\",\n \"id\": \"doc_jd73dw6fn02sj28.pdf\",\n \"issuedDate\": \"2022-01-01T00:00:00.000Z\",\n \"effectiveDate\": \"2022-01-02T00:00:00.000Z\",\n \"createdAt\": \"2022-01-01T00:00:00.000Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {}
}{
"success": false,
"message": "Input validation failed due to one or more missing or invalid parameters. Review the request and try again."
}{
"message": "Too Many Requests"
}Sandbox
Trigger Policy event
The Policy event will be sent to the webhookUri specified when generating an Ignition token.
Refer to the Sandbox guide for more details.
POST
/
sandbox
/
policies
/
{id}
/
event
Trigger Policy event
curl --request POST \
--url https://sandbox.axle.insure/sandbox/policies/{id}/event \
--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 '
{
"type": "auto",
"carrier": "state-farm",
"policyNumber": "123456789",
"isActive": true,
"effectiveDate": "2022-10-22T04:00:00.000Z",
"expirationDate": "2023-10-22T04:00:00.000Z",
"premium": 999.99,
"address": {
"addressLine1": "123 Fake St.",
"addressLine2": "Unit 456",
"city": "Atlanta",
"state": "Georgia",
"postalCode": "30315",
"country": "USA"
},
"coverages": [
{
"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"
}
],
"exclusions": [
{
"code": "WIND",
"label": "Wind Exclusion"
}
],
"properties": [
{
"id": "prp_uSdzLVpi8c76H7kl6AQ-F",
"type": "vehicle",
"data": {
"vin": "SMTD44GN3HT812287",
"model": "CR-V",
"year": "2017",
"make": "HONDA",
"use": "pleasure"
}
}
],
"insureds": [
{
"firstName": "Armaan",
"lastName": "Sikand",
"dateOfBirthYear": "1993",
"licenseNo": "•••••7259",
"licenseState": "GA",
"dateOfBirth": null,
"type": "primary"
}
],
"thirdParties": [
{
"name": "Super Leasing Trust",
"type": "lessor",
"address": {
"addressLine1": "Po Box 105205",
"state": "GA",
"city": "Atlanta",
"postalCode": "30348"
}
}
],
"documents": [
{
"source": "carrier",
"name": "Declaration Page",
"type": [
"declaration-page"
],
"url": "<signed-url>",
"id": "doc_jd73dw6fn02sj28.pdf",
"issuedDate": "2022-01-01T00:00:00.000Z",
"effectiveDate": "2022-01-02T00:00:00.000Z",
"createdAt": "2022-01-01T00:00:00.000Z"
}
]
}
'import requests
url = "https://sandbox.axle.insure/sandbox/policies/{id}/event"
payload = {
"type": "auto",
"carrier": "state-farm",
"policyNumber": "123456789",
"isActive": True,
"effectiveDate": "2022-10-22T04:00:00.000Z",
"expirationDate": "2023-10-22T04:00:00.000Z",
"premium": 999.99,
"address": {
"addressLine1": "123 Fake St.",
"addressLine2": "Unit 456",
"city": "Atlanta",
"state": "Georgia",
"postalCode": "30315",
"country": "USA"
},
"coverages": [
{
"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"
}
],
"exclusions": [
{
"code": "WIND",
"label": "Wind Exclusion"
}
],
"properties": [
{
"id": "prp_uSdzLVpi8c76H7kl6AQ-F",
"type": "vehicle",
"data": {
"vin": "SMTD44GN3HT812287",
"model": "CR-V",
"year": "2017",
"make": "HONDA",
"use": "pleasure"
}
}
],
"insureds": [
{
"firstName": "Armaan",
"lastName": "Sikand",
"dateOfBirthYear": "1993",
"licenseNo": "•••••7259",
"licenseState": "GA",
"dateOfBirth": None,
"type": "primary"
}
],
"thirdParties": [
{
"name": "Super Leasing Trust",
"type": "lessor",
"address": {
"addressLine1": "Po Box 105205",
"state": "GA",
"city": "Atlanta",
"postalCode": "30348"
}
}
],
"documents": [
{
"source": "carrier",
"name": "Declaration Page",
"type": ["declaration-page"],
"url": "<signed-url>",
"id": "doc_jd73dw6fn02sj28.pdf",
"issuedDate": "2022-01-01T00:00:00.000Z",
"effectiveDate": "2022-01-02T00:00:00.000Z",
"createdAt": "2022-01-01T00:00:00.000Z"
}
]
}
headers = {
"x-client-id": "<x-client-id>",
"x-access-token": "<x-access-token>",
"x-client-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-client-id': '<x-client-id>',
'x-access-token': '<x-access-token>',
'x-client-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 'auto',
carrier: 'state-farm',
policyNumber: '123456789',
isActive: true,
effectiveDate: '2022-10-22T04:00:00.000Z',
expirationDate: '2023-10-22T04:00:00.000Z',
premium: 999.99,
address: {
addressLine1: '123 Fake St.',
addressLine2: 'Unit 456',
city: 'Atlanta',
state: 'Georgia',
postalCode: '30315',
country: 'USA'
},
coverages: [
{
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'
}
],
exclusions: [{code: 'WIND', label: 'Wind Exclusion'}],
properties: [
{
id: 'prp_uSdzLVpi8c76H7kl6AQ-F',
type: 'vehicle',
data: {
vin: 'SMTD44GN3HT812287',
model: 'CR-V',
year: '2017',
make: 'HONDA',
use: 'pleasure'
}
}
],
insureds: [
{
firstName: 'Armaan',
lastName: 'Sikand',
dateOfBirthYear: '1993',
licenseNo: '•••••7259',
licenseState: 'GA',
dateOfBirth: null,
type: 'primary'
}
],
thirdParties: [
{
name: 'Super Leasing Trust',
type: 'lessor',
address: {
addressLine1: 'Po Box 105205',
state: 'GA',
city: 'Atlanta',
postalCode: '30348'
}
}
],
documents: [
{
source: 'carrier',
name: 'Declaration Page',
type: ['declaration-page'],
url: '<signed-url>',
id: 'doc_jd73dw6fn02sj28.pdf',
issuedDate: '2022-01-01T00:00:00.000Z',
effectiveDate: '2022-01-02T00:00:00.000Z',
createdAt: '2022-01-01T00:00:00.000Z'
}
]
})
};
fetch('https://sandbox.axle.insure/sandbox/policies/{id}/event', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.axle.insure/sandbox/policies/{id}/event",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'auto',
'carrier' => 'state-farm',
'policyNumber' => '123456789',
'isActive' => true,
'effectiveDate' => '2022-10-22T04:00:00.000Z',
'expirationDate' => '2023-10-22T04:00:00.000Z',
'premium' => 999.99,
'address' => [
'addressLine1' => '123 Fake St.',
'addressLine2' => 'Unit 456',
'city' => 'Atlanta',
'state' => 'Georgia',
'postalCode' => '30315',
'country' => 'USA'
],
'coverages' => [
[
'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'
]
],
'exclusions' => [
[
'code' => 'WIND',
'label' => 'Wind Exclusion'
]
],
'properties' => [
[
'id' => 'prp_uSdzLVpi8c76H7kl6AQ-F',
'type' => 'vehicle',
'data' => [
'vin' => 'SMTD44GN3HT812287',
'model' => 'CR-V',
'year' => '2017',
'make' => 'HONDA',
'use' => 'pleasure'
]
]
],
'insureds' => [
[
'firstName' => 'Armaan',
'lastName' => 'Sikand',
'dateOfBirthYear' => '1993',
'licenseNo' => '•••••7259',
'licenseState' => 'GA',
'dateOfBirth' => null,
'type' => 'primary'
]
],
'thirdParties' => [
[
'name' => 'Super Leasing Trust',
'type' => 'lessor',
'address' => [
'addressLine1' => 'Po Box 105205',
'state' => 'GA',
'city' => 'Atlanta',
'postalCode' => '30348'
]
]
],
'documents' => [
[
'source' => 'carrier',
'name' => 'Declaration Page',
'type' => [
'declaration-page'
],
'url' => '<signed-url>',
'id' => 'doc_jd73dw6fn02sj28.pdf',
'issuedDate' => '2022-01-01T00:00:00.000Z',
'effectiveDate' => '2022-01-02T00:00:00.000Z',
'createdAt' => '2022-01-01T00:00:00.000Z'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <x-access-token>",
"x-client-id: <x-client-id>",
"x-client-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.axle.insure/sandbox/policies/{id}/event"
payload := strings.NewReader("{\n \"type\": \"auto\",\n \"carrier\": \"state-farm\",\n \"policyNumber\": \"123456789\",\n \"isActive\": true,\n \"effectiveDate\": \"2022-10-22T04:00:00.000Z\",\n \"expirationDate\": \"2023-10-22T04:00:00.000Z\",\n \"premium\": 999.99,\n \"address\": {\n \"addressLine1\": \"123 Fake St.\",\n \"addressLine2\": \"Unit 456\",\n \"city\": \"Atlanta\",\n \"state\": \"Georgia\",\n \"postalCode\": \"30315\",\n \"country\": \"USA\"\n },\n \"coverages\": [\n {\n \"code\": \"BI\",\n \"label\": \"Bodily Injury\",\n \"limitPerPerson\": 250000,\n \"limitPerAccident\": 500000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"PD\",\n \"label\": \"Property Damage\",\n \"limitPerAccident\": 100000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"COMP\",\n \"label\": \"Comprehensive\",\n \"deductible\": 375,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"COLL\",\n \"label\": \"Collision\",\n \"deductible\": 375,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"UMBI\",\n \"label\": \"Uninsured Bodily Injury\",\n \"limitPerPerson\": 100000,\n \"limitPerAccident\": 300000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n }\n ],\n \"exclusions\": [\n {\n \"code\": \"WIND\",\n \"label\": \"Wind Exclusion\"\n }\n ],\n \"properties\": [\n {\n \"id\": \"prp_uSdzLVpi8c76H7kl6AQ-F\",\n \"type\": \"vehicle\",\n \"data\": {\n \"vin\": \"SMTD44GN3HT812287\",\n \"model\": \"CR-V\",\n \"year\": \"2017\",\n \"make\": \"HONDA\",\n \"use\": \"pleasure\"\n }\n }\n ],\n \"insureds\": [\n {\n \"firstName\": \"Armaan\",\n \"lastName\": \"Sikand\",\n \"dateOfBirthYear\": \"1993\",\n \"licenseNo\": \"•••••7259\",\n \"licenseState\": \"GA\",\n \"dateOfBirth\": null,\n \"type\": \"primary\"\n }\n ],\n \"thirdParties\": [\n {\n \"name\": \"Super Leasing Trust\",\n \"type\": \"lessor\",\n \"address\": {\n \"addressLine1\": \"Po Box 105205\",\n \"state\": \"GA\",\n \"city\": \"Atlanta\",\n \"postalCode\": \"30348\"\n }\n }\n ],\n \"documents\": [\n {\n \"source\": \"carrier\",\n \"name\": \"Declaration Page\",\n \"type\": [\n \"declaration-page\"\n ],\n \"url\": \"<signed-url>\",\n \"id\": \"doc_jd73dw6fn02sj28.pdf\",\n \"issuedDate\": \"2022-01-01T00:00:00.000Z\",\n \"effectiveDate\": \"2022-01-02T00:00:00.000Z\",\n \"createdAt\": \"2022-01-01T00:00:00.000Z\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-client-id", "<x-client-id>")
req.Header.Add("x-access-token", "<x-access-token>")
req.Header.Add("x-client-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.axle.insure/sandbox/policies/{id}/event")
.header("x-client-id", "<x-client-id>")
.header("x-access-token", "<x-access-token>")
.header("x-client-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"auto\",\n \"carrier\": \"state-farm\",\n \"policyNumber\": \"123456789\",\n \"isActive\": true,\n \"effectiveDate\": \"2022-10-22T04:00:00.000Z\",\n \"expirationDate\": \"2023-10-22T04:00:00.000Z\",\n \"premium\": 999.99,\n \"address\": {\n \"addressLine1\": \"123 Fake St.\",\n \"addressLine2\": \"Unit 456\",\n \"city\": \"Atlanta\",\n \"state\": \"Georgia\",\n \"postalCode\": \"30315\",\n \"country\": \"USA\"\n },\n \"coverages\": [\n {\n \"code\": \"BI\",\n \"label\": \"Bodily Injury\",\n \"limitPerPerson\": 250000,\n \"limitPerAccident\": 500000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"PD\",\n \"label\": \"Property Damage\",\n \"limitPerAccident\": 100000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"COMP\",\n \"label\": \"Comprehensive\",\n \"deductible\": 375,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"COLL\",\n \"label\": \"Collision\",\n \"deductible\": 375,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"UMBI\",\n \"label\": \"Uninsured Bodily Injury\",\n \"limitPerPerson\": 100000,\n \"limitPerAccident\": 300000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n }\n ],\n \"exclusions\": [\n {\n \"code\": \"WIND\",\n \"label\": \"Wind Exclusion\"\n }\n ],\n \"properties\": [\n {\n \"id\": \"prp_uSdzLVpi8c76H7kl6AQ-F\",\n \"type\": \"vehicle\",\n \"data\": {\n \"vin\": \"SMTD44GN3HT812287\",\n \"model\": \"CR-V\",\n \"year\": \"2017\",\n \"make\": \"HONDA\",\n \"use\": \"pleasure\"\n }\n }\n ],\n \"insureds\": [\n {\n \"firstName\": \"Armaan\",\n \"lastName\": \"Sikand\",\n \"dateOfBirthYear\": \"1993\",\n \"licenseNo\": \"•••••7259\",\n \"licenseState\": \"GA\",\n \"dateOfBirth\": null,\n \"type\": \"primary\"\n }\n ],\n \"thirdParties\": [\n {\n \"name\": \"Super Leasing Trust\",\n \"type\": \"lessor\",\n \"address\": {\n \"addressLine1\": \"Po Box 105205\",\n \"state\": \"GA\",\n \"city\": \"Atlanta\",\n \"postalCode\": \"30348\"\n }\n }\n ],\n \"documents\": [\n {\n \"source\": \"carrier\",\n \"name\": \"Declaration Page\",\n \"type\": [\n \"declaration-page\"\n ],\n \"url\": \"<signed-url>\",\n \"id\": \"doc_jd73dw6fn02sj28.pdf\",\n \"issuedDate\": \"2022-01-01T00:00:00.000Z\",\n \"effectiveDate\": \"2022-01-02T00:00:00.000Z\",\n \"createdAt\": \"2022-01-01T00:00:00.000Z\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.axle.insure/sandbox/policies/{id}/event")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-client-id"] = '<x-client-id>'
request["x-access-token"] = '<x-access-token>'
request["x-client-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"auto\",\n \"carrier\": \"state-farm\",\n \"policyNumber\": \"123456789\",\n \"isActive\": true,\n \"effectiveDate\": \"2022-10-22T04:00:00.000Z\",\n \"expirationDate\": \"2023-10-22T04:00:00.000Z\",\n \"premium\": 999.99,\n \"address\": {\n \"addressLine1\": \"123 Fake St.\",\n \"addressLine2\": \"Unit 456\",\n \"city\": \"Atlanta\",\n \"state\": \"Georgia\",\n \"postalCode\": \"30315\",\n \"country\": \"USA\"\n },\n \"coverages\": [\n {\n \"code\": \"BI\",\n \"label\": \"Bodily Injury\",\n \"limitPerPerson\": 250000,\n \"limitPerAccident\": 500000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"PD\",\n \"label\": \"Property Damage\",\n \"limitPerAccident\": 100000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"COMP\",\n \"label\": \"Comprehensive\",\n \"deductible\": 375,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"COLL\",\n \"label\": \"Collision\",\n \"deductible\": 375,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n },\n {\n \"code\": \"UMBI\",\n \"label\": \"Uninsured Bodily Injury\",\n \"limitPerPerson\": 100000,\n \"limitPerAccident\": 300000,\n \"property\": \"prp_uSdzLVpi8c76H7kl6AQ-F\"\n }\n ],\n \"exclusions\": [\n {\n \"code\": \"WIND\",\n \"label\": \"Wind Exclusion\"\n }\n ],\n \"properties\": [\n {\n \"id\": \"prp_uSdzLVpi8c76H7kl6AQ-F\",\n \"type\": \"vehicle\",\n \"data\": {\n \"vin\": \"SMTD44GN3HT812287\",\n \"model\": \"CR-V\",\n \"year\": \"2017\",\n \"make\": \"HONDA\",\n \"use\": \"pleasure\"\n }\n }\n ],\n \"insureds\": [\n {\n \"firstName\": \"Armaan\",\n \"lastName\": \"Sikand\",\n \"dateOfBirthYear\": \"1993\",\n \"licenseNo\": \"•••••7259\",\n \"licenseState\": \"GA\",\n \"dateOfBirth\": null,\n \"type\": \"primary\"\n }\n ],\n \"thirdParties\": [\n {\n \"name\": \"Super Leasing Trust\",\n \"type\": \"lessor\",\n \"address\": {\n \"addressLine1\": \"Po Box 105205\",\n \"state\": \"GA\",\n \"city\": \"Atlanta\",\n \"postalCode\": \"30348\"\n }\n }\n ],\n \"documents\": [\n {\n \"source\": \"carrier\",\n \"name\": \"Declaration Page\",\n \"type\": [\n \"declaration-page\"\n ],\n \"url\": \"<signed-url>\",\n \"id\": \"doc_jd73dw6fn02sj28.pdf\",\n \"issuedDate\": \"2022-01-01T00:00:00.000Z\",\n \"effectiveDate\": \"2022-01-02T00:00:00.000Z\",\n \"createdAt\": \"2022-01-01T00:00:00.000Z\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {}
}{
"success": false,
"message": "Input validation failed due to one or more missing or invalid parameters. Review the request and try again."
}{
"message": "Too Many Requests"
}Authorizations
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
Your client ID. This will be shared with you during onboarding.
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.
The access token required for access to the requested Account. Returned as part of Exchange Token.
Path Parameters
The unique ID for the requested policy. Returned by Get Account for each Policy associated with the Account.
Body
application/json
The Policy object fields you would like to change. For list of all possible fields refer to Policy
Type of insurance policy that the Policy object represents.
Available options:
auto, motorcycle, home, condo Example:
"auto"
Insurance carrier that is the source for the Policy data.
Example:
"state-farm"
Identifier of the policy, as specified by the insurance carrier.
Example:
"123456789"
Active status of the policy, as specified by the insurance carrier. If an Ignition session is completed with result manual, this field will be undefined.
Example:
true
ISO 8601 timestamp of current term effective date of the policy, as specified by the insurance carrier.
Example:
"2022-10-22T04:00:00.000Z"
ISO 8601 timestamp of current term expiration date of the policy, as specified by the insurance carrier.
Example:
"2023-10-22T04:00:00.000Z"
Total policy premium, as specified by the insurance carrier. Note: only available for type=home policies
Example:
999.99
Primary address associated with the policy.
Show child attributes
Show child attributes
Example:
{
"addressLine1": "123 Fake St.",
"addressLine2": "Unit 456",
"city": "Atlanta",
"state": "Georgia",
"postalCode": "30315",
"country": "USA"
}
List of coverage types and levels offered by the policy.
Show child attributes
Show child attributes
Example:
[
{
"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"
}
]
List of policy exclusions (i.e., explicit removal of coverage afforded by the policy).
Show child attributes
Show child attributes
Example:
[
{ "code": "WIND", "label": "Wind Exclusion" }
]
List of properties (such as a vehicle or dwelling) afforded coverage by the policy.
Show child attributes
Show child attributes
List of entities (such as an individuals or businesses) afforded direct coverage by the policy.
Show child attributes
Show child attributes
List of external parties with interest in the policy.
Show child attributes
Show child attributes
List of documents (such as declaration pages and policy agreements) associated with the policy.
Show child attributes
Show child attributes
Was this page helpful?
⌘I