Download OpenAPI specification:Download
Boost API example documentation.
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: |
Generates an access token which must be used on all subsequent API calls.
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. |
client_id required | string Your Client ID |
client_secret required | string Your Client Secret |
grant_type required | string Value:"client_credentials" |
Token
Request is invalid
Internal Server Error
Production environment
Staging environment
Issues a new quote.
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. |
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. |
Quote was successfully created. Response contains our representation of the quote.
Request is invalid.
Unauthorized. The bearer authentication failed.
Internal Server Error.
Production environment
Staging environment
Retreives the most recent version of the requested quote given the quote number.
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. |
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. |
Successfully retrieved the quote.
Unauthorized. The bearer authentication failed.
Resource does not exist.
Internal Server Error.
Production environment
Staging environment
Modifies the specified quote with the provided data.
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. |
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. |
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. |
Successfully updated the quote. Response contains our representation of the quote.
Request is invalid.
Unauthorized. The bearer authentication failed.
Resource does not exist.
Resource cannot be modified.
Internal Server Error.
Production environment
Staging environment
Issues a new policy with the given the input data. Policy goes in force on the specified effective_date.
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. |
data required | object Data for creating a policy from a quote requiring a stripe token. |
Policy was successfully created.
Request is invalid.
Unauthorized. The bearer authentication failed.
Forbidden. The operation is not allowed.
Internal Server Error.
Production environment
Staging environment
List previously created policies
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. |
Policy list was successfully retrieved.
Production environment
Staging environment