Boost API Example Documentation (1.3.0)

Download OpenAPI specification:Download

Boost API example documentation.

Authentication

OAuth2

Boost's API uses OAuth2.0 with a client credentials grant to authenticate all requests. This HTTP authentication scheme requires that a valid token is provided with every API request. Be sure to first retrieve a valid token from the authentication endpoint. See POST /auth/oauth2/token for details about how to get a token.

Security scheme type:	OAuth2
clientCredentials OAuth Flow	Token URL: /auth/oauth2/token Scopes:

OAuth2

Get OAuth2 Token

Generates an access token which must be used on all subsequent API calls.

header Parameters

Content-Type

required

string

Value:"application/x-www-form-urlencoded"

Entity header to indicate that the media type of the resource is www-form-urlencoded.

Request Body schema: application/x-www-form-urlencoded

client_id required	string Your Client ID
client_secret required	string Your Client Secret
grant_type required	string Value:"client_credentials"

Responses

200

Token

400

Request is invalid

500

Internal Server Error

post /auth/oauth2/token

Production environment

https://api.insurtech.dev/auth/oauth2/token

Staging environment

https://staging.api.insurtech.dev/auth/oauth2/token

Response samples

application/json

Copy

Expand all Collapse all

{

"token_type": "bearer",
"access_token": "JDKSjkdnasknxkasjd",
"expires_in": 7200

}

Quoting

Quote Management

Issue Quote

Issues a new quote.

Authorizations:

OAuth2

header Parameters

Boost-User required	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ Example: "0aa54c55-7890-abcd-1234-789012345678" Boost provided agent UUID that identifies the user.
Content-Type required	string Value:"application/vnd.api+json" Entity header to indicate that the media type of the resource is JSON:API.

Request Body schema: application/vnd.api+json

data required	object All values for the request are in this top-level object.
included required	Array of objects or objects or objects Array of included objects.

Responses

201

Quote was successfully created. Response contains our representation of the quote.

400

Request is invalid.

401

Unauthorized. The bearer authentication failed.

500

Internal Server Error.

post /quotes

Production environment

https://api.insurtech.dev/quotes

Staging environment

https://staging.api.insurtech.dev/quotes

Request samples

Payload

application/vnd.api+json

Copy

Expand all Collapse all

{

"data":
{
- "type": "quote",
- "attributes":
  {
  - "limit": "1000.00",
  - "deductible": "250.00",
  - "policy_state": "NY",
  - "effective_date": "2019-02-20T00:00:00-00:00",
  - "term_end_date": "2019-08-20T00:00:00-00:00",
  - "external_reference": "00000001",
  - "metadata": { }
  },
- "relationships":
  {
  - "product":
    {
    "data":
    {
    "type": "product",
    "id": "537a1c0a-b768-4678-8f22-718c090f07d7"
    }
    },
  - "coverages":
    {
    "data":
    [
    {
    "type": "coverage",
    "lid": "coverage-lid-1"
    },
    {
    "type": "coverage",
    "lid": "coverage-lid-2"
    }
    ]
    },
  - "customer":
    {
    "data":
    {
    "type": "customer",
    "lid": "customer-lid-1"
    }
    },
  - "insured_risk":
    {
    "data":
    {
    "type": "insured_risk",
    "lid": "insured-risk-lid-1"
    }
    }
  }
},
"included":
[
- {
  - "type": "coverage",
  - "lid": "coverage-lid-1",
  - "attributes":
    {
    "deductible": "150.00",
    "limit": "1500.00",
    "metadata": { }
    },
  - "relationships":
    {
    "product_coverage":
    {
    "data":
    {
    "type": "product_coverage",
    "id": "10d23db8-6914-4690-a29d-0f2936082acb"
    }
    }
    }
  },
- {
  - "type": "coverage",
  - "lid": "coverage-lid-2",
  - "attributes":
    {
    "deductible": "300.00",
    "limit": "3000.00",
    "metadata": { }
    },
  - "relationships":
    {
    "product_coverage":
    {
    "data":
    {
    "type": "product_coverage",
    "id": "317ec5f9-fbb6-44ab-b293-77ca5d4fb236"
    }
    }
    }
  },
- {
  - "type": "customer",
  - "lid": "customer-lid-1",
  - "attributes":
    {
    "external_reference": "abc-123-xyz-324",
    "type": "person",
    "business_name": null,
    "first_name": "John",
    "last_name": "Does",
    "email": "[email protected]",
    "phone": "212-212-2121",
    "mailing_address":
    {
    "address1": "123 Main St",
    "address2": "Suite 1",
    "city": "Phoenix",
    "state": "AZ",
    "zip": "85025"
    },
    "billing_address":
    {
    "address1": "123 Main St",
    "address2": "Suite 1",
    "city": "Phoenix",
    "state": "AZ",
    "zip": "85025"
    }
    }
  },
- {
  - "type": "insured_risk",
  - "lid": "insured-risk-lid-1",
  - "attributes":
    {
    "data":
    {
    "key": "value"
    }
    }
  }
]

}

Response samples

application/vnd.api+json

Copy

Expand all Collapse all

{

"data":
{
- "type": "quote",
- "id": "BLU-XX-T63XWYHFE",
- "attributes":
  {
  - "limit": "1000",
  - "deductible": "1000",
  - "policy_state": "AZ",
  - "effective_date": "2018-08-01T00:00:00+00:00",
  - "term_end_date": "2018-08-01T00:00:00+00:00",
  - "external_reference": "000000001",
  - "metadata": { },
  - "bindable_on": "2018-08-01T00:00:00+00:00",
  - "term_premium": "123.45",
  - "valid_until": "2018-08-01T00:00:00+00:00",
  - "convertable_on": "2018-08-01T00:00:00+00:00",
  - "converted_on": "2018-08-01T00:00:00+00:00",
  - "status": "draft",
  - "installment_plans":
    {
    "property1":
    [
    {
    "billing_period": "2018-08-01T00:00:00+00:00",
    "amount_due": "123.45",
    "due_date": "2018-08-01T00:00:00+00:00",
    "taxes": "12.34",
    "fees": "12.34"
    }
    ],
    "property2":
    [
    {
    "billing_period": "2018-08-01T00:00:00+00:00",
    "amount_due": "123.45",
    "due_date": "2018-08-01T00:00:00+00:00",
    "taxes": "12.34",
    "fees": "12.34"
    }
    ]
    },
  - "min_premium": "12.34",
  - "state_tax": "12.34",
  - "state_fees": "12.34",
  - "service_fees": "12.34",
  - "billing_fees": "12.34"
  },
- "relationships":
  {
  - "coverages":
    {
    "data":
    [
    {
    "type": "coverage",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    ]
    },
  - "customer":
    {
    "data":
    {
    "type": "customer",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    },
  - "insured_risk":
    {
    "data":
    {
    "type": "insured_risk",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    },
  - "product":
    {
    "data":
    {
    "type": "product",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    },
  - "agent":
    {
    "data":
    {
    "type": "agent",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    }
  }
},
"included":
[
- {
  - "type": "coverage",
  - "id": "d64d47eb-c7a6-4128-985b-0ecc79284608",
  - "lid": "2",
  - "attributes":
    {
    "deductible": "1000",
    "limit": "1000",
    "premium": "100.00",
    "metadata": { }
    },
  - "relationships":
    {
    "product_coverage":
    {
    "data":
    {
    "type": "product_coverage",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    }
    }
  }
]

}

Get Quote

Retreives the most recent version of the requested quote given the quote number.

Authorizations:

OAuth2

path Parameters

quote_number

required

string^BLU-[0-9a-zA-Z]{2,3}-[0-9a-zA-Z]{9}$

Example: "BLU-XX-2FM83109D"

Quote number identifying the quote to be operated on.

header Parameters

Boost-User required	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ Example: "0aa54c55-7890-abcd-1234-789012345678" Boost provided agent UUID that identifies the user.
Accept required	string Value:"application/vnd.api+json" Accept header to indicate that the desired response is JSON:API.

Responses

200

Successfully retrieved the quote.

401

Unauthorized. The bearer authentication failed.

404

Resource does not exist.

500

Internal Server Error.

get /quotes/{quote_number}

Production environment

https://api.insurtech.dev/quotes/{quote_number}

Staging environment

https://staging.api.insurtech.dev/quotes/{quote_number}

Response samples

application/vnd.api+json

Copy

Expand all Collapse all

{

"data":
{
- "type": "quote",
- "id": "BLU-AG-T63XWYHFE",
- "attributes":
  {
  - "limit": "1000",
  - "deductible": "1000",
  - "policy_state": "AZ",
  - "effective_date": "2018-08-01T00:00:00+00:00",
  - "term_end_date": "2018-08-01T00:00:00+00:00",
  - "external_reference": "000000001",
  - "metadata": { },
  - "bindable_on": "2018-08-01T00:00:00+00:00",
  - "term_premium": "123.45",
  - "valid_until": "2018-08-01T00:00:00+00:00",
  - "convertable_on": "2018-08-01T00:00:00+00:00",
  - "converted_on": "2018-08-01T00:00:00+00:00",
  - "status": "draft",
  - "installment_plans":
    {
    "property1":
    [
    {
    "billing_period": "2018-08-01T00:00:00+00:00",
    "amount_due": "123.45",
    "due_date": "2018-08-01T00:00:00+00:00",
    "taxes": "12.34",
    "fees": "12.34"
    }
    ],
    "property2":
    [
    {
    "billing_period": "2018-08-01T00:00:00+00:00",
    "amount_due": "123.45",
    "due_date": "2018-08-01T00:00:00+00:00",
    "taxes": "12.34",
    "fees": "12.34"
    }
    ]
    },
  - "min_premium": "12.34",
  - "state_tax": "12.34",
  - "state_fees": "12.34",
  - "service_fees": "12.34",
  - "billing_fees": "12.34"
  },
- "relationships":
  {
  - "coverages":
    {
    "data":
    [
    {
    "type": "coverage",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    ]
    },
  - "customer":
    {
    "data":
    {
    "type": "customer",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    },
  - "insured_risk":
    {
    "data":
    {
    "type": "insured_risk",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    },
  - "product":
    {
    "data":
    {
    "type": "product",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    },
  - "agent":
    {
    "data":
    {
    "type": "agent",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    }
  }
},
"included":
[
- {
  - "type": "coverage",
  - "id": "d64d47eb-c7a6-4128-985b-0ecc79284608",
  - "attributes":
    {
    "deductible": "1000",
    "limit": "1000",
    "premium": "100.00",
    "metadata": { }
    },
  - "relationships":
    {
    "product_coverage":
    {
    "data":
    {
    "type": "product_coverage",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    }
    }
  }
]

}

Modify Quote

Modifies the specified quote with the provided data.

Authorizations:

OAuth2

path Parameters

quote_number

required

string^BLU-[0-9a-zA-Z]{2,3}-[0-9a-zA-Z]{9}$

Example: "BLU-XX-2FM83109D"

Quote number identifying the quote to be operated on.

header Parameters

Boost-User required	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ Example: "0aa54c55-7890-abcd-1234-789012345678" Boost provided agent UUID that identifies the user.
Content-Type required	string Value:"application/vnd.api+json" Entity header to indicate that the media type of the resource is JSON:API.

Request Body schema: application/vnd.api+json

data required	object All values for the request are in this top-level object.
included required	Array of objects or objects or objects Array of included objects.

Responses

200

Successfully updated the quote. Response contains our representation of the quote.

400

Request is invalid.

401

Unauthorized. The bearer authentication failed.

404

Resource does not exist.

409

Resource cannot be modified.

500

Internal Server Error.

put /quotes/{quote_number}

Production environment

https://api.insurtech.dev/quotes/{quote_number}

Staging environment

https://staging.api.insurtech.dev/quotes/{quote_number}

Request samples

Payload

application/vnd.api+json

Copy

Expand all Collapse all

{

"data":
{
- "type": "quote",
- "id": "BLU-XX-X2EWQWAJ1",
- "attributes":
  {
  - "limit": "1000.00",
  - "deductible": "250.00",
  - "policy_state": "NY",
  - "effective_date": "2019-02-20T00:00:00-00:00",
  - "term_end_date": "2019-08-20T00:00:00-00:00",
  - "external_reference": "00000001",
  - "metadata": { }
  },
- "relationships":
  {
  - "product":
    {
    "data":
    {
    "type": "product",
    "id": "537a1c0a-b768-4678-8f22-718c090f07d7"
    }
    },
  - "coverages":
    {
    "data":
    [
    {
    "type": "coverage",
    "lid": "coverage-lid-1"
    },
    {
    "type": "coverage",
    "lid": "coverage-lid-2"
    }
    ]
    },
  - "customer":
    {
    "data":
    {
    "type": "customer",
    "lid": "customer-lid-1"
    }
    },
  - "insured_risk":
    {
    "data":
    {
    "type": "insured_risk",
    "lid": "insured-risk-lid-1"
    }
    }
  }
},
"included":
[
- {
  - "type": "coverage",
  - "lid": "coverage-lid-1",
  - "attributes":
    {
    "deductible": "150.00",
    "limit": "1500.00",
    "metadata": { }
    },
  - "relationships":
    {
    "product_coverage":
    {
    "data":
    {
    "type": "product_coverage",
    "id": "10d23db8-6914-4690-a29d-0f2936082acb"
    }
    }
    }
  },
- {
  - "type": "coverage",
  - "lid": "coverage-lid-2",
  - "attributes":
    {
    "deductible": "300.00",
    "limit": "3000.00",
    "metadata": { }
    },
  - "relationships":
    {
    "product_coverage":
    {
    "data":
    {
    "type": "product_coverage",
    "id": "317ec5f9-fbb6-44ab-b293-77ca5d4fb236"
    }
    }
    }
  },
- {
  - "type": "customer",
  - "lid": "customer-lid-1",
  - "attributes":
    {
    "type": "person",
    "business_name": null,
    "first_name": "John",
    "last_name": "Does",
    "email": "[email protected]",
    "phone": "212-212-2121",
    "mailing_address":
    {
    "address1": "123 Main St",
    "address2": "Suite 1",
    "city": "Phoenix",
    "state": "AZ",
    "zip": "85025"
    },
    "billing_address":
    {
    "address1": "123 Main St",
    "address2": "Suite 1",
    "city": "Phoenix",
    "state": "AZ",
    "zip": "85025"
    }
    }
  },
- {
  - "type": "insured_risk",
  - "lid": "insured-risk-lid-1",
  - "attributes":
    {
    "data":
    {
    "key": "value"
    }
    }
  }
]

}

Response samples

application/vnd.api+json

Copy

Expand all Collapse all

{

"data":
{
- "type": "quote",
- "id": "BLU-AG-T63XWYHFE",
- "attributes":
  {
  - "limit": "1000",
  - "deductible": "1000",
  - "policy_state": "AZ",
  - "effective_date": "2018-08-01T00:00:00+00:00",
  - "term_end_date": "2018-08-01T00:00:00+00:00",
  - "external_reference": "000000001",
  - "metadata": { },
  - "bindable_on": "2018-08-01T00:00:00+00:00",
  - "term_premium": "123.45",
  - "valid_until": "2018-08-01T00:00:00+00:00",
  - "convertable_on": "2018-08-01T00:00:00+00:00",
  - "converted_on": "2018-08-01T00:00:00+00:00",
  - "status": "draft",
  - "installment_plans":
    {
    "property1":
    [
    {
    "billing_period": "2018-08-01T00:00:00+00:00",
    "amount_due": "123.45",
    "due_date": "2018-08-01T00:00:00+00:00",
    "taxes": "12.34",
    "fees": "12.34"
    }
    ],
    "property2":
    [
    {
    "billing_period": "2018-08-01T00:00:00+00:00",
    "amount_due": "123.45",
    "due_date": "2018-08-01T00:00:00+00:00",
    "taxes": "12.34",
    "fees": "12.34"
    }
    ]
    },
  - "min_premium": "12.34",
  - "state_tax": "12.34",
  - "state_fees": "12.34",
  - "service_fees": "12.34",
  - "billing_fees": "12.34"
  },
- "relationships":
  {
  - "coverages":
    {
    "data":
    [
    {
    "type": "coverage",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    ]
    },
  - "customer":
    {
    "data":
    {
    "type": "customer",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    },
  - "insured_risk":
    {
    "data":
    {
    "type": "insured_risk",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    },
  - "product":
    {
    "data":
    {
    "type": "product",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    },
  - "agent":
    {
    "data":
    {
    "type": "agent",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    }
  }
},
"included":
[
- {
  - "type": "coverage",
  - "id": "d64d47eb-c7a6-4128-985b-0ecc79284608",
  - "lid": "2",
  - "attributes":
    {
    "deductible": "1000",
    "limit": "1000",
    "premium": "100.00",
    "metadata": { }
    },
  - "relationships":
    {
    "product_coverage":
    {
    "data":
    {
    "type": "product_coverage",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    }
    }
  }
]

}

Policies

Policy Management

Issue Policy

Issues a new policy with the given the input data. Policy goes in force on the specified effective_date.

Authorizations:

OAuth2

header Parameters

Boost-User required	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ Example: "53f85c54-f471-444d-80a7-9feb1951ff46" UUID that identifies the user.
Content-Type required	string Value:"application/vnd.api+json" Entity header to indicate that the media type of the resource is JSON:API.

Request Body schema:
application/vnd.api+json

data

required

object

Data for creating a policy from a quote requiring a stripe token.

Responses

201

Policy was successfully created.

400

Request is invalid.

401

Unauthorized. The bearer authentication failed.

403

Forbidden. The operation is not allowed.

500

Internal Server Error.

post /policies

Production environment

https://api.insurtech.dev/policies

Staging environment

https://staging.api.insurtech.dev/policies

Request samples

Payload

Copy

Expand all Collapse all

{

"data":
{
- "type": "policy",
- "attributes":
  {
  - "quote_number": "BLU-XX-T63XWYHFE",
  - "installment_plan": "ANNUAL",
  - "stripe_token": "tok_mastercard",
  - "external_id": "1234567890"
  },
- "relationships":
  {
  - "additional_interests":
    {
    "data":
    [
    {
    "type": "customer",
    "id": "55efaaf6-2bb2-4cdd-b5ec-5475af712c52"
    }
    ]
    },
  - "parent":
    {
    "data":
    {
    "type": "policy",
    "id": "9c5fa6b9-4107-4709-8b44-e188b9a45d33"
    }
    }
  }
}

}

Response samples

application/vnd.api+json

Copy

Expand all Collapse all

{

"data":
{
- "type": "policy",
- "id": "3c81edd0-f684-4812-9737-dc0299ffa9c2",
- "attributes":
  {
  - "created_date": "2018-08-01T10:41:32.437818+0000",
  - "modified_date": "2018-08-01T10:41:32.437833+0000",
  - "actual_end_date": "2019-06-01T00:00:00.000000+0000",
  - "status": "issued",
  - "earned_premium": "100.00000",
  - "earned_tax": "0.01644",
  - "earned_fees": "0.10142",
  - "cancel_reason": "fraud",
  - "cancel_description": "Client committed fraud when applying for this policy.",
  - "policy_number": "BLU-XX-2FM83109D",
  - "effective_date": "2018-08-01T00:00:00.000000+0000",
  - "external_reference": "000000001",
  - "limit": "1000000",
  - "deductible": "1000",
  - "policy_state": "AZ",
  - "metadata": { },
  - "term_end_date": "2019-08-01T00:00:00.0000000+0000",
  - "written_premium": "1234.56",
  - "issue_date": "2018-08-01T00:00:00.000000+0000",
  - "non_renewal_notice_date": "2018-08-01T00:00:00.000000+0000",
  - "cancellation_notice_date": "2018-08-01T00:00:00.000000+0000",
  - "requested_cancellation_date": "2018-08-01T00:00:00.000000+0000",
  - "state_tax": "12.34",
  - "state_fees": "12.34",
  - "service_fees": "12.34",
  - "term_premium": "1234.56",
  - "billing_fees": "12.34"
  },
- "relationships":
  {
  - "coverages":
    {
    "data":
    [
    {
    "type": "coverage",
    "id": "937f7f44-3acc-44f8-9c4b-1d0715d473a1"
    }
    ],
    "meta":
    {
    "count": 1
    }
    },
  - "insured_risk":
    {
    "data":
    {
    "type": "insured_risk",
    "id": "889c16f9-c236-4c29-9721-aa5bbaeb7107"
    }
    },
  - "customer":
    {
    "data":
    {
    "type": "customer",
    "id": "fd5a4e30-a897-4383-a0a4-bd62970f6d23"
    }
    },
  - "product":
    {
    "data":
    {
    "type": "product",
    "id": "e9b259af-1c34-4a8f-90e7-aca4445d84f5"
    }
    },
  - "parent":
    {
    "data":
    {
    "type": "policy",
    "id": "4a86d3da-a6df-42a8-a9be-e8e8ff5657fe"
    }
    },
  - "additional_interests":
    {
    "data":
    [
    {
    "type": "customer",
    "id": "d64d47eb-c7a6-4128-985b-0ecc79284608"
    }
    ],
    "meta":
    {
    "count": 1
    }
    },
  - "additional_insured":
    {
    "data":
    [
    {
    "type": "customer",
    "id": "ac30a222-4ad6-4bd5-b8f3-944db5ee474e"
    }
    ],
    "meta":
    {
    "count": 1
    }
    },
  - "agent":
    {
    "data":
    {
    "type": "agent",
    "id": "8483335c-eeab-4b8b-8aba-e96acf0b98b7"
    }
    },
  - "installment_plan":
    {
    "data":
    {
    "type": "installment_plan",
    "id": "2e3dc75c-3f7d-4721-80df-b5fac6617825"
    }
    }
  }
},
"included":
[
- {
  - "type": "coverage",
  - "id": "a5f0c4fc-737e-41e3-b88b-fb56020766a8",
  - "attributes":
    {
    "created_date": "2018-08-01T10:41:32.437818+0000",
    "modified_date": "2018-08-01T10:41:32.437833+0000",
    "deductible": "1000",
    "limit": "1000000",
    "premium": "150.00",
    "additional_fees": "1.23",
    "revision_date": "2019-01-30T12:32:15.122040+0000"
    },
  - "relationships":
    {
    "policy":
    {
    "data":
    {
    "type": "policy",
    "id": "f445dde9-32d2-46cf-8cac-9fe4409fee0b"
    }
    },
    "endorsement":
    {
    "data":
    {
    "type": "endorsement",
    "id": "b1deb55f-8108-400c-9443-e8bc61d1928d"
    }
    },
    "coverage":
    {
    "data":
    {
    "type": "product_coverage",
    "id": "902522f9-f38c-40c5-9b4c-bb401be5f0d9"
    }
    }
    }
  }
]

}

List Policies

List previously created policies

Authorizations:

OAuth2

header Parameters

Boost-User required	string <uuid> ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ Example: "53f85c54-f471-444d-80a7-9feb1951ff46" UUID that identifies the user.
Accept	string Value:"application/vnd.api+json" Header to indicate that desired response type is JSON:API.

Responses

200

Policy list was successfully retrieved.

get /policies

Production environment

https://api.insurtech.dev/policies

Staging environment

https://staging.api.insurtech.dev/policies

Response samples

application/vnd.api+json

Copy

Expand all Collapse all

{

"data":
[
- {
  - "type": "policy",
  - "id": "3c81edd0-f684-4812-9737-dc0299ffa9c2",
  - "attributes":
    {
    "created_date": "2018-08-01T10:41:32.437818+0000",
    "modified_date": "2018-08-01T10:41:32.437833+0000",
    "document_id": "530c8393-ebb6-4625-a4be-fe9bc5a75d4a",
    "actual_end_date": "2019-06-01T00:00:00.000000+0000",
    "status": "issued",
    "earned_premium": "100.00000",
    "earned_tax": "0.01644",
    "earned_fees": "0.10142",
    "cancel_reason": "fraud",
    "cancel_description": "Client committed fraud when applying for this policy.",
    "policy_number": "BLU-XX