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:
    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

    application/vnd.api+json
    Copy
    Expand all Collapse all
    {
    • "data":
      {
      },
    • "included":
      [
      ]
    }

    Response samples

    application/vnd.api+json
    Copy
    Expand all Collapse all
    {
    • "data":
      {
      },
    • "included":
      [
      ]
    }

    Get Quote

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

    Authorizations:
    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":
      {
      },
    • "included":
      [
      ]
    }

    Modify Quote

    Modifies the specified quote with the provided data.

    Authorizations:
    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

    application/vnd.api+json
    Copy
    Expand all Collapse all
    {
    • "data":
      {
      },
    • "included":
      [
      ]
    }

    Response samples

    application/vnd.api+json
    Copy
    Expand all Collapse all
    {
    • "data":
      {
      },
    • "included":
      [
      ]
    }

    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:
    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:
    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

    Copy
    Expand all Collapse all
    {
    • "data":
      {
      }
    }

    Response samples

    application/vnd.api+json
    Copy
    Expand all Collapse all
    {
    • "data":
      {
      },
    • "included":
      [
      ]
    }

    List Policies

    List previously created policies

    Authorizations:
    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":
      [