Build

InsuranceNowAPI

Leverage the InsuranceNow API to easily connect apps and services to the industry's leading core platform for insurers like you.

Overview

Guidewire InsuranceNow API

Connect apps and services or build your own experience with the Guidewire InsuranceNow API.

The InsuranceNow API v5 endpoints are available within the system through an interactive API interface. The interactive API uses the Swagger OpenAPI specification to provide a way to view the API endpoints and execute API requests.


https://host:port/coreapi/version/endpoint

curl -X GET "https://xx.xx.xxx.xxx:xxxxx/coreapi/v5/customers?postalCode=95119" -H "accept: application/json" -H "authorization: Basic YWRtaW46OTk5OQ=="

Related info

Case Study
Even with no IT staff, insurer implements full suite under budget and achieves time-to-value faster than expected.
Guide
Get started with the Guidewire Payments API with this QuickStart guide written by our Engineers for Guidewire developers.
Use Case
Want to build beautiful and engaging digital experiences for Guidewire? This page has everything you need to get started.

Getting Started

Guidewire InsuranceNow API concepts

The Guidewire InsuranceNow API uses the Representational State Transfer (REST) architecture to
issue requests and receive responses from the server.

Resources

Resources and sub-resources identify the objects that can be created, retrieved, and updated by the RESTful API. When using the API, data objects such as a quote, application, or customer are resources. Data objects such as a coverage or driver on a specific policy are considered sub-resources./applications​/{systemId}is an example of a resource and /applications/{systemId}/drivers/{driverNumber}is an example of a sub-resource. Using sub-resources is useful when you need access to certain details such as the list of coverages on a specific risk.

Methods

The v5 API uses GET, PATCH, PUT, POST, and DELETE methods to create, read, update, and delete resources. Some methods are safe and some are idempotent. Safe methods do not modify resources. An idempotent method can be called multiple times and the result on the resource is the same. Methods that are safe are also idempotent.

Full endpoints

For certain resources, the API provides an endpoint that interacts with the entire payload of that resource and an endpoint that interacts with the resource without including all of its sub-resources. API endpoints that end with /full interact with the entire resource which includes the sub-resources. For example, PUT​/applications​/{systemId}requires less payload than PUT /applications/{systemId}/full. The payload for PUT /applications/{systemId}/full needs to include content about sub-resources such as locations and lines.

Links

The body of the API response can include one or more _links sections. These links provide direct access to other related items you might want to access. For example, when you get the full application response there are many sets of links available in the response. The coverages section of the full application response includes links to the coverage, its parent, and the associated list of coverage items:

        
            ...
          "coverages": [
            {
              ...
              "_links": [
                {
                  "rel": "self",
                  "href": "/coreapi/v5/applications/883/lines/Homeowners/risks/1/coverages/CovA"
                },
                {
                  "rel": "parent",
                  "href": "/coreapi/v5/applications/883/lines/Homeowners/risks/1"
                },
                {
                  "rel": "coverageItems",
                  "href": "/coreapi/v5/applications/883/lines/Homeowners/risks/1/coverages/CovA/coverageItems"
                }
              ]
        
    

Try it out

Make your first Guidewire InsuranceNow API call

The interactive API includes an option to “try out” the API. The Try it out option executes the API requests against the environment that you access. To perform test operations, use the Try it out option on the development or quality assurance environments.

To “try out” an API request, you enter authentication information, enter request parameters, execute the request, and then view the response.

Authentication

Authentication tokens and authorization credentials are created and entered in the API “try it out” interface. For full instructions on generating and entering tokens, read the full documentation.

Parameters

Easily enter parameters and execute your first API call directly from InsuranceNow.

InsuranceNow API request
InsuranceNow API response

Results

Immediately see the results of your API request. Server response codes 200 or 201 indicate a successful API Call.

Next Steps

Start building

With the InsuranceNow API you can now get started creating engaging digital experiences and wire them up to InsuranceNow. This API supports use cases for offering digital consumer quote and buy workflows, as well as agent quote, submission, bind, and issue flows. For a full explanation of the API capabilities, requirements, and how to develop digital apps using the API, read the InsuranceNow API v5 documentation.

Consumer quote and buy

Consumer Sales Portal built with the Guidewire InsuranceNow API

Agent portal

Example InsuranceNow Agent Portal

Related info

Case Study
Even with no IT staff, insurer implements full suite under budget and achieves time-to-value faster than expected.
Guide
Get started with the Guidewire Payments API with this QuickStart guide written by our Engineers for Guidewire developers.
Use Case
Want to build beautiful and engaging digital experiences for Guidewire? This page has everything you need to get started.

Don’t see what you are looking for?