guidewire.insnow
Module guidewire.insnow
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_guidewire.insnow_0.1.0.png)
ballerinax/guidewire.insnow Ballerina library
Overview
Guidewire InsuranceNow is a cloud-based insurance platform offering comprehensive tools for policy, billing, and claims management, designed to streamline operations and improve customer service in the insurance industry.
The ballerinax/guidewire.insnow
package provides a client API to connect to Guidewire InsuranceNow cloud API using Ballerina.
The Ballerina Guidewire InsuranceNow connector is compatible with the Guidewire InsuranceNow 2023.3 (Innsbruck)
REST API version.
Setup guide
To use the Ballerina Guidewire InsuranceNow connector, access to the Guidewire API is required. Access is granted to partners or customers of the Guidewire platform. To become a partner or customer, reach out to Guidewire's sales team via the Guidewire website. For detailed instructions on obtaining authentication/authorization keys, please go through the portal development guide.
Quickstart
To use the Guidewire InsuranceNow connector in your Ballerina application, modify the .bal
file as follows:
Step 1: Import the module
Import ballerinax/guidewire.insnow
module into your Ballerina project.
import ballerinax/guidewire.insnow;
Step 2: Instantiate a new connector
Create an insnow:Client
object with your domain URL and relevant authentication options.
configurable string username = ?; configurable string password = ?; insnow:ConnectionConfig insnowConfig = { auth: { username, password } }; insnow:Client insuranceNow = check new (insnowConfig, "https://<your-domain>/coreapi/v5");
Step 3: Invoke the connector operations
Now, utilize the available connector operations.
List applications
insnow:ListApplication applications = check insuranceNow->/applications();
Create application
insnow:Attachment attachment = { compositeFile: [ { fileName: "insurance_application_form.pdf", id: "comp-app-form-001" } ], description: "Application and supporting documents for auto insurance policy.", filename: "complete_insurance_application_bundle.pdf", id: "doc-789456", linkReferences: [ { description: "Link to customer's policy.", id: "link-policy-456789", idRef: "policy-123456", modelName: "CustomerPolicy", status: "Pending", systemIdRef: "gw-insurance-system-001" } ], tags: [ { id: "tag-policy-application", name: "Policy Application", tagTemplateIdRef: "template-policy-app" }, { id: "tag-auto-insurance", name: "Auto Insurance", tagTemplateIdRef: "template-auto-ins" } ], templateId: "template-insurance-application" }; _ = check insuranceNow->/applications/["123"]/documents.post(attachment);
Step 4: Run the Ballerina application
bal run
Examples
The Guidewire InsuranceNow connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Online application portal - Implement an online insurance application portal using Guidewire InsuranceNow cloud API.
Clients![](/images/permalink.svg)
guidewire.insnow: Client![](/images/permalink.svg)
This OpenAPI specification outlines the interface for the Guidewire InsuranceNow Cloud API version 5.0.0, providing a comprehensive description of available endpoints, operations, parameters, request bodies, and response structures for integrating with the cloud-based insurance platform, InsuranceNow. Designed to streamline operations for insurance companies, InsuranceNow offers functionalities including policy management, claims management, and customer engagement. The API enables developers to access and manipulate insurance data, facilitating automation, custom integrations, and workflow enhancements. Key features include policy management, claims processing, and customer management.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
init (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
get addresses/countries![](/images/permalink.svg)
function get addresses/countries("asc"|"desc" sortType) returns ListCountry|error
Returns a list of supported countries.
Parameters
- sortType "asc"|"desc" (default "asc") - Indicates the method used to sort the results by name.
Return Type
- ListCountry|error - Successful response.
get addresses/countries/[string isoCd]![](/images/permalink.svg)
function get addresses/countries/[string isoCd]() returns AddressCountryTemplate|error
Returns the AddressCountryTemplate bean for the given IsoCd (e.g. US).
Return Type
- AddressCountryTemplate|error - Successful response.
get addresses/googlePlacesFill![](/images/permalink.svg)
Fills an address from a Google Places search. Using the placeId from a Google Places search, an address will be returned that has all of the address components filled. If the placeId is not known, Google Places will be called to search and fill the address components.
Parameters
- addressLine string? (default ()) - The address line to have Google Places search and fill the address components.
- placeId string? (default ()) - Place Id from the Google Places search.
post addresses/isVerifiedRequest![](/images/permalink.svg)
Indicates whether a given address is already verified.
Parameters
- payload Address -
post addresses/verificationRequest![](/images/permalink.svg)
function post addresses/verificationRequest(ListAddress payload, "Combined"|"Uncombined" addressType) returns Response|error
Normalizes, verifies, and provides a more complete address. The verified address may include additional address properties. The response either returns one or more addresses that match the given address, or it will return an error if the address cannot be verified. If more than one address is returned, select an address and then resubmit the API request to perform address verification on the selected address.
Parameters
- payload ListAddress -
- addressType "Combined"|"Uncombined" (default "Combined") - Indicates the requested format of the address after verification. Uncombined returns the street address in components. The default is Combined.
get applications![](/images/permalink.svg)
function get applications(string? applicationOrQuoteNumber, string? continuationId, string? createdSinceDate, string? customerId, boolean? includeClosed, boolean? includeDeleted, string? 'limit, string? optionalFields, string? policyId, string? providerId, boolean? recentlyViewed, string? status, string? transactionCd, string? transactionCdGroup, string? 'type) returns ListApplication|error
Returns a list of quotes or applications.
Parameters
- applicationOrQuoteNumber string? (default ()) - Application or quote number.
- continuationId string? (default ()) - Indicates the starting offset for the API results when you want to return a specific portion of the full results. You can use this parameter with the limit parameter. For example, the limit on your first API call was 100 and the results populated a list on the page. To request the next page of 100 results, call the API again with continuationId=101 and limit=100.
- createdSinceDate string? (default ()) - Select applications where application creation date is equal to or greater than the provided createdSinceDate.
- customerId string? (default ()) - Customer ID number.
- includeClosed boolean? (default ()) - Includes closed applications. If true, results will include "Closed" applications. If false (or not provided), results will not include "Closed" applications.
- includeDeleted boolean? (default ()) - Includes deleted applications. If true, results will include "Deleted" applications. If false (or not provided), results will not include "Deleted" applications.
- 'limit string? (default ()) - The maximum number of results to return.
- optionalFields string? (default ()) - Comma-delimited list of optional fields to be included. Currently supports customer and product.
- policyId string? (default ()) - Policy ID.
- providerId string? (default ()) - Provider code number.
- recentlyViewed boolean? (default ()) - Finds applications recently viewed by the caller/user. If true, results will be restricted to applications recently viewed by the caller/user. If false (or not provided), results will not be restricted to applications recently viewed by the caller/user.
- status string? (default ()) - Application status (e.g. In Process).
- transactionCd string? (default ()) - Transaction code (e.g. New Business) Use where a specific transactionCd(s) is known. Accepts a comma-separated list of values. Ignored when transactionCdGroup contains a value.
- transactionCdGroup string? (default ()) - Find applications by transactionCdGroup. Use when a specific transactionCd(s) is not known. Accepts a comma-separated list of values. Valid values are Quote, Cancellation, Renewal, or Other.
- 'type string? (default ()) - Application type. Valid values are Application, QuickQuote, or Quote.
Return Type
- ListApplication|error - Successful response.
post applications![](/images/permalink.svg)
Starts a new QuickQuote or Quote. To create a QuickQuote, basicPolicy productVersionIdRef (e.g. Homeowners-1.00.00), providerRef (e.g. 19), and effectiveDt strings are required. To create a Quote, basicPolicy productVersionIdRef, providerRef, and effectiveDt strings, plus one piece of insured information to create a customer, are required.
Parameters
- payload Quote -
- requestedTypeCd string? (default ()) - Starts a quote of the specified type. Valid values are QuickQuote or Quote. If a type is not specified, a QuickQuote will be created if the selected product supports quick quotes and you can perform quick quotes; otherwise, a Quote will be created. If QuickQuote is specified but the selected product does not support quick quotes or you cannot perform quick quotes, then either a 400 or 403 response code will be returned.
delete applications/[string systemId]![](/images/permalink.svg)
Delete the quote or application.
post applications/[string systemId]/bindRequest![](/images/permalink.svg)
Converts a quote to an application.
post applications/[string systemId]/convertToQuoteRequest![](/images/permalink.svg)
Converts a QuickQuote to a Quote.
get applications/[string systemId]/documents![](/images/permalink.svg)
function get applications/[string systemId]/documents() returns ListDocument|error
Returns a list of documents for a quote or application.
Return Type
- ListDocument|error - Successful response.
post applications/[string systemId]/documents![](/images/permalink.svg)
function post applications/[string systemId]/documents(Attachment payload) returns Response|error
Adds an attachment to a quote or application.
Parameters
- payload Attachment -
delete applications/[string systemId]/documents/[string documentId]![](/images/permalink.svg)
function delete applications/[string systemId]/documents/[string documentId]() returns Response|error
Deletes an attachment associated with a quote or application. Requires the attachment ref number (e.g. "Attachment-26808155-290885540").
get applications/[string systemId]/documents/[string documentId]/content![](/images/permalink.svg)
function get applications/[string systemId]/documents/[string documentId]/content() returns byte[]|error
Downloads a document for a quote or application. Requires the attachment ref number (e.g. "Attachment-26808155-290885540").
Return Type
- byte[]|error - Successful response.
get applications/[string systemId]/drivers![](/images/permalink.svg)
function get applications/[string systemId]/drivers(string? continuationId, boolean? includeDeleted, string? 'limit, "Driver"|"NonDriver"? typeCd) returns ListDriver|error
Returns a list of the drivers or non-drivers of a quote or application.
Parameters
- continuationId string? (default ()) - Indicates the starting offset for the API results when you want to return a specific portion of the full results.
- includeDeleted boolean? (default ()) - Includes deleted drivers/non-drivers. If true, results will include "Deleted" drivers/non-drivers. If false (or not provided), results will not include "Deleted" drivers/non-drivers.
- 'limit string? (default ()) - For pagination -- the maximum number of results to return.
- typeCd "Driver"|"NonDriver"? (default ()) - Filter by type of driver.
Return Type
- ListDriver|error - Successful response.
post applications/[string systemId]/drivers![](/images/permalink.svg)
Creates a new driver or non-driver. You must include a partyTypeCd (DriverParty or NonDriverParty). Other details may be required depending on the insurance product being quoted.
Parameters
- payload Driver -
get applications/[string systemId]/drivers/[int:Signed32 driverNumber]![](/images/permalink.svg)
function get applications/[string systemId]/drivers/[int:Signed32 driverNumber]() returns Driver|error
Returns details about a driver or non-driver.
put applications/[string systemId]/drivers/[int:Signed32 driverNumber]![](/images/permalink.svg)
function put applications/[string systemId]/drivers/[int:Signed32 driverNumber](Driver payload) returns Driver|error
Replaces the details about a driver or non-driver.
Parameters
- payload Driver -
delete applications/[string systemId]/drivers/[int:Signed32 driverNumber]![](/images/permalink.svg)
function delete applications/[string systemId]/drivers/[int:Signed32 driverNumber]() returns Response|error
Deletes a driver/non-driver.
patch applications/[string systemId]/drivers/[int:Signed32 driverNumber]![](/images/permalink.svg)
function patch applications/[string systemId]/drivers/[int:Signed32 driverNumber](Driver payload) returns Driver|error
Makes changes to details about a driver/non-driver.
Parameters
- payload Driver -
get claims/[string systemId]/documents![](/images/permalink.svg)
function get claims/[string systemId]/documents() returns ListDocument|error
Returns the list of documents attached to a claim.
Return Type
- ListDocument|error - Successful response.
post claims/[string systemId]/documents![](/images/permalink.svg)
function post claims/[string systemId]/documents(DocumentDetail payload) returns Response|error
Adds an attachment to a claim.
Parameters
- payload DocumentDetail -
get claims/[string systemId]/notes![](/images/permalink.svg)
Returns a list of notes for a claim.
post claims/[string systemId]/notes![](/images/permalink.svg)
function post claims/[string systemId]/notes(NoteDetail payload) returns Response|error
Adds a note to a claim.
Parameters
- payload NoteDetail -
get policies![](/images/permalink.svg)
function get policies(string? continuationId, string? createdSinceDate, string? customerId, string? expiredDateAfter, boolean? includePriorTerms, string? 'limit, string? optionalFields, string? policyNumber, string? providerRef, boolean? recentlyViewed, string? status) returns ListPolicy|error
Returns a list of policies.
Parameters
- continuationId string? (default ()) - Indicates the starting list value for the API results when you want to return a specific portion of the full results. You can use this parameter with the limit parameter. For example, if the limit on your first API call was 10 and the results populated a list on the page. To request the next page of 10 results, call the API again with continuationId=11 and limit=10.
- createdSinceDate string? (default ()) - Selects policies where policy creation date is equal to or greater than the provided createdSinceDate (e.g. 2020-01-01).
- customerId string? (default ()) - Finds policies by customer id (e.g. 212).
- expiredDateAfter string? (default ()) - Selects policies where policy expiration date is equal to or lesser than the provided expirationDateBefore (e.g. 2020-01-01).
- includePriorTerms boolean? (default ()) - Includes prior terms.If true, results will include prior terms. If false (or not provided), results will not include prior terms.
- 'limit string? (default ()) - Indicates how many results to return.
- optionalFields string? (default ()) - Comma-delimited list of optional fields to be included. Currently supports customer and product.
- policyNumber string? (default ()) - Finds policies by policyNumber (e.g. HO00000058).
- providerRef string? (default ()) - Filters policies by provider identifier (e.g. 28).
- recentlyViewed boolean? (default ()) - Limits policies to those recently viewed by the caller or user. If true, results will be restricted to policies recently viewed by the caller or user. If false (or not provided), results will not be restricted to policies recently viewed by the caller or user.
- status string? (default ()) - Finds policies by policy status (e.g Active).
Return Type
- ListPolicy|error - Successful response.
get policies/[string systemId]![](/images/permalink.svg)
function get policies/[string systemId](string? asOfDate) returns PolicyDetails|error
Returns the full details of a policy.
Parameters
- asOfDate string? (default ()) - Returns the policy details from a specified date (e.g. 2021-01-01). If not provided, the current date will be used.
Return Type
- PolicyDetails|error - Successful response.
patch policies/[string systemId]![](/images/permalink.svg)
function patch policies/[string systemId](PolicyDetails payload) returns PolicyDetails|error
Updates the preferred delivery method and insured email address of the policy. Requires the systemId.
Parameters
- payload PolicyDetails -
Return Type
- PolicyDetails|error - Successful response.
Records![](/images/permalink.svg)
guidewire.insnow: Address![](/images/permalink.svg)
Comprehensive details about an address, encapsulating both the physical location attributes and metadata for validation, geocoding, and postal delivery optimization.
Fields
- addition string? - Additional detail to further specify the location within complex addresses, such as unit or apartment number.
- additionalLegal string? - Any legal descriptors that provide further detail to the address, often used in legal contexts or when precise property identification is necessary.
- addr1 string - The primary address line, typically containing the street number and name.
- addr2 string? - Secondary address line, used for additional location information, such as building or suite number.
- addr3 string? - Tertiary address line for further detail, less commonly used.
- addr4 string? - Quaternary address line, utilized in complex addressing scenarios where multiple lines are needed for clarity.
- addrTypeCd string - A code indicating the type of address, such as 'ContactAddr' for a primary contact address.
- addressHash string? - A unique hash value representing the address, used for identifying and detecting changes to address data.
- attention string? - Designates a specific individual or department at the address for targeted delivery.
- barcodeDigits string? - Numeric representation of the postal barcode associated with the address, used for mail sorting and delivery.
- block string? - The block number or identifier, relevant in urban planning and real estate contexts.
- carrierRoute string? - A postal service designation indicating the specific route for mail delivery, comprising a type and code.
- city string - The city or town associated with the address.
- congressCode string? - Identifies the congressional district in which the address is located, relevant for political and demographic purposes.
- county string? - The county in which the address resides, providing an additional layer of geographic specificity.
- countyCode string? - A specific code assigned to the county, used for administrative and geographic classification.
- dpv string? - Delivery Point Validation code, indicating the deliverability status of the address as per postal service validation.
- dpvDesc string? - A textual description of the Delivery Point Validation code, offering insights into mail delivery capabilities.
- dpvNotes string? - Additional notes from the Delivery Point Validation process, highlighting specific issues or considerations.
- dpvNotesDesc string? - Descriptive elaboration on the DPV notes, providing context and explanations for validation outcomes.
- geocodeLevel string? - Indicates the precision of geocoding for the address, such as 'street' or 'postal code' level.
- geocodeLevelDescription string? - Narrative description of the geocode level, explaining the extent of location accuracy achieved.
- id string - A unique identifier for the address within the system, used for tracking and reference.
- latitude string? - The latitude coordinate of the address, resulting from geocoding processes.
- legalDesc string? - A legal narrative description of the property associated with the address, used in formal documentation and contracts.
- longitude string? - The longitude coordinate of the address, resulting from geocoding processes.
- lot string? - Identifies the specific lot within a subdivision or development, relevant in property identification.
- meridian string? - Refers to the principal meridian used in surveying and legal descriptions within the region of the address.
- plssCounty string? - Indicates the Public Land Survey System (PLSS) county code, relevant in the United States for land division and legal descriptions.
- postDirectional string? - A directional suffix in an address, specifying the compass point after the street name, for geographical clarity.
- postalCode string? - The ZIP or postal code, crucial for mail sorting, delivery, and regional identification.
- preDirectional string? - A directional prefix in an address, specifying the compass point before the street name, enhancing locational accuracy.
- primaryMeridian string? - Specifies the primary meridian reference, important in certain legal and surveying contexts.
- primaryNumber string? - The number assigned to the building or property within the street, fundamental for address identification.
- primaryNumberSuffix string? - A suffix to the primary number, providing additional specificity, such as indicating a range of units.
- range string? - Specifies the range for rural or agricultural properties, often used in conjunction with township and section.
- rangeDir string? - Directional indicator for the range, providing spatial orientation in rural addressing schemes.
- regionCd string - The full name of the country or major administrative region for the address.
- regionISOCd string - The ISO Alpha-2 country code, standardizing country identification across international systems.
- score string? - A numerical score representing the accuracy of the address verification, where higher scores indicate higher confidence levels.
- secondaryDesignator string? - Indicates a specific unit or sub-location within a larger complex or building, such as 'Apt' or 'Suite'.
- secondaryNumber string? - The specific number or identifier of the unit within a larger building, essential for accurate mail delivery to multi-unit locations.
- section string? - Designates a specific section within the Public Land Survey System (PLSS) or a similar land division system, providing additional precision to rural and agricultural property locations.
- stateProvCd string - The code representing the state or province of the address. This may be an abbreviation or a full name, depending on local conventions and requirements.
- streetName string? - The name of the street or thoroughfare, excluding numerical or directional prefixes and suffixes, essential for identifying the location within a city or region.
- suffix string? - A suffix indicating the type or category of the street or thoroughfare, such as Road, Avenue, Circle, etc., providing additional context to the street name.
- township string? - Identifies the township or equivalent jurisdictional division, used primarily in rural addressing to specify location within larger, often unincorporated, areas.
- townshipDir string? - Directional indicator associated with the township, aiding in the geographical orientation and precise location of properties within larger rural or unincorporated areas.
- validated string? - Indicates the validation status of the address, particularly the accuracy of the township, section, and range components, confirming the address has been verified against official records or databases.
- verificationHash string - A cryptographic hash value generated from the address details. This hash is used to ensure the integrity of the address data and to verify that no changes have occurred since the last validation.
- verificationMsg string? - A message summarizing the outcome of the latest address verification attempt, providing insights into any discrepancies, issues, or confirmation of address accuracy.
guidewire.insnow: AddressCountryTemplate![](/images/permalink.svg)
Defines the template for constructing and validating addresses within a specific country. This schema includes details like the required fields, address format, and labels for various address components, tailored to the country's postal system.
Fields
- addressLines string? - Indicates the number of address lines that are supported or required by the address format of this country.
- addressStateProvinceTemplates AddressStateProvinceTemplates? - Provides a structured format for representing state or province information associated with addresses, facilitating consistency and accuracy in address data across various geographic locations.
- cityLabel string? - The label used for the city field in address forms, which may vary based on the country's addressing system.
- countryName string? - The full name of the country to which this address template applies, ensuring clarity and consistency in international addressing.
- format string? - Specifies the format used for addresses in this country, including the order of address components and the separators used between them.
- id string? - A unique identifier for the template, typically using the two-letter ISO country code for easy reference.
- postalCodeExamples string? - Provides examples of valid postal or zip codes for the country, useful as a guide for users when entering address information.
- postalCodeLabel string? - The label used for the postal or zip code field, which may be customized based on the country's postal system terminology.
- postalCodeRegex string? - A regular expression pattern used to validate the format of postal or zip codes for addresses in this country, ensuring data accuracy and compliance with local postal standards.
- requiredFields string? - A comma-separated list of address fields that are mandatory for this country, allowing for dynamic form validation that adapts to different countries' addressing requirements.
- stateProvLabel string? - The label for the state or province field in address forms, accommodating the terminology used in the country's addressing system.
guidewire.insnow: AddressStateProvinceTemplates![](/images/permalink.svg)
Provides a structured format for representing state or province information associated with addresses, facilitating consistency and accuracy in address data across various geographic locations.
Fields
- stateProvinces StateProvinces[]? - A collection of state or province entities, each conforming to the defined StateProvinces schema, allowing for detailed representation of geographic administrative divisions.
guidewire.insnow: Application![](/images/permalink.svg)
Detailed representation of an insurance application, including its status, ownership, associated customer and product information, and permissions regarding user actions.
Fields
- _links Link[]? - Hypermedia links related to the application, facilitating navigation to related resources and actions such as editing or inquiry.
- applicationMini ApplicationMini? - Provides a compact overview of an insurance application, summarizing key information and linking to detailed resources for further exploration. This schema is optimized for quick access and overview purposes.
- canEdit boolean? - Indicates whether the current user has permissions to edit the application, reflecting access control based on user roles and application status.
- canInquiry boolean? - Indicates whether the current user is permitted to make inquiries regarding the application, typically used for customer service and support roles.
- currentOwner string? - Identifies the current owner or responsible party for the application, which may be an individual agent or a team within the insurance organization.
- customerInfo CustomerInfo? - Captures essential identification and reference information for a customer, supporting customer management, service, and correspondence within the insurance system.
- productInfo ProductInfo? - Provides key details about an insurance product, including its identification and descriptive name, facilitating product-specific processing and categorization.
- ref string? - A unique reference identifier for the application, used within the system for tracking, management, and retrieval purposes.
guidewire.insnow: ApplicationInfo![](/images/permalink.svg)
Encapsulates a detailed record of an insurance application's lifecycle within the system, tracking its creation, updates, mailing history, closure, and any related correction or reinstatement transactions.
Fields
- addDt string? - The date when the application was initially added to the system, marking the start of its lifecycle.
- addTm string? - The precise time of day when the application was added to the system, complementing the add date for accurate tracking.
- addUser string? - The identifier (e.g., username) of the user who added the application, providing an audit trail for creation actions.
- closeComment string? - Any comments or notes regarding the reasons or circumstances surrounding the application's closure.
- closeDt string? - The date when the application was officially closed, terminating its active processing or consideration within the system.
- closeReasonCd string? - A code that categorizes the reason for the application's closure, such as 'withdrawn' or 'issued'.
- closeSubReasonCd string? - A more specific code that provides additional detail on the reason for application closure, used for finer categorization.
- closeSubReasonLabel string? - The textual description corresponding to the close sub-reason code, offering human-readable insight into the closure reason.
- closeTm string? - The exact time of day when the application was closed, providing precise timing alongside the closure date.
- closeUser string? - The identifier of the user who performed the closure action, contributing to the audit trail.
- correctedByTransactionNumber int? - If the application was corrected by a subsequent transaction, this is the number of that correcting transaction.
- correctionOfTransactionNumber int? - If this application serves as a correction, this is the original transaction number that it corrects.
- firstMailedDt string? - The date when the application or associated documents were first mailed to the customer or relevant party.
- id string? - A unique identifier for the application information record, ensuring distinct and retrievable records within the system.
- iterationDescription string? - A description or identifier for the particular iteration or version of the application, useful in tracking changes over time.
- lastMailedDt string? - The most recent date on which the application or related documents were mailed out, indicating the latest communication attempt.
- masterQuoteRef string? - A reference to the master quote associated with this application, linking application data to quoting details.
- needByDt string? - The date by which the application processing needs to be completed, often tied to coverage start dates or customer requirements.
- pendForReleaseInd boolean? - Indicates if the application is currently on hold, pending release for further processing or decision-making.
- reinstatedByTransactionNumber int? - Identifies the transaction number that led to the reinstatement of this application, if it was previously closed or withdrawn.
- reinstatementOfTransactionNumber int? - For applications that are reinstatements, this is the original transaction number of the application that is being reinstated.
- renewalApplyInd boolean? - Flags whether the application is marked for renewal, indicating an ongoing relationship or coverage continuation.
- renewalApplyOfTransactionNumber int? - For renewal applications, this field links to the transaction number of the previous application or policy being renewed.
- submittedDt string? - The date when the application was formally submitted for review or processing, moving it forward in the underwriting or issuance pipeline.
- updateDt string? - The date of the last update made to the application, reflecting the most recent changes or progress.
- updateTm string? - The time at which the last update to the application was made, providing time-specific tracking of modifications.
- updateUser string? - The identifier of the user who made the most recent update to the application, part of the comprehensive audit trail.
guidewire.insnow: ApplicationMini![](/images/permalink.svg)
Provides a compact overview of an insurance application, summarizing key information and linking to detailed resources for further exploration. This schema is optimized for quick access and overview purposes.
Fields
- _links Link[]? - A collection of hypermedia links to related resources, enabling easy navigation to detailed views of the application, policy information, and other associated resources.
- applicationInfo ApplicationInfo? - Encapsulates a detailed record of an insurance application's lifecycle within the system, tracking its creation, updates, mailing history, closure, and any related correction or reinstatement transactions.
- applicationNumber string? - The unique identifier assigned to the application, serving as a primary reference for tracking and management throughout the application process.
- auditAccountRef string? - A reference identifier linking the application to its associated audit account, facilitating financial tracking and audit processes.
- basicPolicy BasicPolicy? - Summarizes foundational information about a policy, including its identification, associated affinity group, and details about its payment plan.
guidewire.insnow: Attachment![](/images/permalink.svg)
Encapsulates details about an attachment, including files, metadata, and policies related to the retention and deletion of the attachment.
Fields
- compositeFile CompositeFile[]? - An array of file identifiers that are to be combined into this single composite attachment, facilitating document management and access.
- description string? - A user or system-provided description of the attachment, often detailing its content, purpose, or any relevant context.
- eraseInfo EraseInfo? - Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations.
- filename string? - The storage path and unique filename under which the attachment is saved on the server, crucial for retrieval and management.
- id string? - A unique identifier for the attachment, facilitating tracking, reference, and operations like update or deletion.
- linkReferences LinkReference[]? - An array of identifiers for other resources or entities within the system that this attachment is linked to, enhancing data connectivity and context.
- memo string? - Optional user-entered notes or commentary about the attachment, which can include usage notes, revision information, or any other pertinent details.
- purgeInfo record {}? - Contains details regarding the policies and processes for purging the attachment from the system, including timelines, methods, and compliance requirements.
- tags Tag[]? - A collection of tags associated with the attachment, serving as metadata for categorization, searchability, and organization.
- templateId string? - Identifies the template from which the attachment was created, if any, linking it to standardized document formats or predefined content structures.
guidewire.insnow: AttributeRef![](/images/permalink.svg)
Encapsulates a reference to a specific attribute within the system, linking issues or other entities to detailed attribute information for clarity and context.
Fields
- attributeId string? - The unique identifier of the attribute to which this reference points, establishing a direct link for data retrieval and analysis.
- id string? - A unique identifier for the attribute reference itself, ensuring the ability to track and manage these references independently within the system.
guidewire.insnow: AuditPayPlan![](/images/permalink.svg)
Defines the payment plan for a policy as adjusted following an audit, which may result in changes to payment schedules or methods based on the audited information.
Fields
- auditPayPlanCd string? - A code representing the specific payment plan determined as a result of the audit, which may differ from the initial payment plan based on actual policy performance or other factors.
- electronicPaymentSource ElectronicPaymentSource? - Defines the details of an electronic payment source, such as bank account or credit card information, used for processing payments within the system. It includes both ACH (Automated Clearing House) and credit card payment methods.
- id string? - A unique identifier for the audit pay plan record, ensuring the ability to reference and apply the specific plan adjustments post-audit.
- payPlanTemplateIdRef string? - References the template from which the audited payment plan was derived, indicating the base plan prior to any adjustments.
- paymentDay string? - Indicates the adjusted day of the month for payment due dates under the audited payment plan, which may have been modified from the original schedule.
guidewire.insnow: BasicPolicy![](/images/permalink.svg)
Summarizes foundational information about a policy, including its identification, associated affinity group, and details about its payment plan.
Fields
- affinityGroupCd string? - The code representing the affinity group associated with the policy, which may qualify the policyholder for certain benefits or discounts.
- auditPayPlan AuditPayPlan? - Defines the payment plan for a policy as adjusted following an audit, which may result in changes to payment schedules or methods based on the audited information.
- autoDataPrefillInd boolean? - Indicator of whether data prefilling is enabled for automatic data capture and form completion.
- branch string? - The branch or division of the insurance provider issuing the policy.
- businessSourceCd string? - The code indicating the source of business, such as direct, broker, or agent.
- cALineSelectedInd boolean? - Indicator of whether commercial auto line coverage is selected in the policy.
- cAPolicyType string? - The type of commercial auto policy, detailing specific coverage options selected.
- cCLineSelectedInd boolean? - Indicator of whether commercial property coverage is selected.
- cCPolicyType string? - The type of commercial property policy, detailing the specific coverage options selected.
- cCSubline string? - Subline code for commercial coverage, providing additional detail on the specific nature of the coverage.
- cGLineSelectedInd boolean? - Indicator of whether general liability coverage is selected.
- cILineSelectedInd boolean? - Indicator of whether commercial inland marine coverage is selected.
- cLLineSelectedInd boolean? - Indicator of whether commercial lines coverage is selected, encompassing a range of commercial policies.
- cPLineSelectedInd boolean? - Indicator of whether commercial package policy coverage is selected.
- cPPolicyType string? - The type of commercial package policy, detailing the specific coverage options selected.
- carrierCd string? - The code representing the insurance carrier providing the policy.
- carrierGroupCd string? - The code representing the group of insurance carriers, if applicable, under which the policy is issued.
- commCLUERequestInd boolean? - Indicator of whether a commercial CLUE (Comprehensive Loss Underwriting Exchange) report has been requested for underwriting purposes.
- comments string? - Free-form comments or notes associated with the policy.
- companyProductCd string? - The product code of the company, identifying the specific insurance product offered.
- controllingStateCd string? - The code of the state that has jurisdiction over the policy, particularly important for multi-state operations.
- dPLineSelectedInd boolean? - Indicator of whether dwelling property coverage is selected.
- description string? - A brief description of the policy, summarizing the key coverage and policy details.
- directorsAndOfficersLineSelectedInd boolean? - Indicator of whether Directors and Officers (D&O) liability coverage is selected.
- displayDescription string? - A description of the policy designed for display purposes, often used in customer-facing documents.
- effectiveDt string? - The effective date of the policy, indicating when coverage begins.
- effectiveTm string? - The effective time of the policy, providing precise coverage start time.
- electronicPaymentSource ElectronicPaymentSource? - Defines the details of an electronic payment source, such as bank account or credit card information, used for processing payments within the system. It includes both ACH (Automated Clearing House) and credit card payment methods.
- employmentAndPracticeLineSelectedInd boolean? - Indicator of whether employment practices liability coverage is selected.
- errorsAndOmissionLineSelectedInd boolean? - Indicator of whether Errors and Omissions (E&O) coverage is selected.
- expirationDt string? - The expiration date of the policy, indicating when coverage ends.
- extendedCoverageInd boolean? - Indicator of whether the policy includes extended coverage beyond standard terms.
- externalId string? - An external identifier for the policy, used for integration with external systems or databases.
- fireLightningInd boolean? - Indicator of whether the policy includes coverage for fire and lightning damage.
- gLLineSelectedInd boolean? - Indicator of whether general liability coverage is selected.
- id string? - The unique identifier for the policy within the system.
- inceptionDt string? - The inception date of the policy, marking the beginning of coverage, distinct from the effective date in some cases.
- inceptionTm string? - The inception time of the policy, providing precise start time of coverage.
- legacyPolicyNumber string? - A policy number from a legacy system, maintained for historical or cross-reference purposes.
- llcOwnedDt string? - The date on which the covered property was transferred to an LLC, if applicable.
- lossSettlementType string? - The type of loss settlement provided by the policy, such as actual cash value or replacement cost.
- manualBillingEntitySplitInd boolean? - Indicator of whether the billing for the policy is manually split among multiple entities.
- manualReinstateInd boolean? - Indicator of whether the policy has been manually reinstated after cancellation or lapse.
- manualReinstateReason string? - The reason for manually reinstating the policy, providing context for the action.
- manualRenewalInd boolean? - Indicator of whether the policy is manually renewed, as opposed to automatically renewed.
- manualRenewalReason string? - The reason for manually renewing the policy, providing context for the renewal decision.
- namedNonOwnedInd boolean? - Indicator of whether the policy includes coverage for named non-owned vehicles or properties.
- oldSubTypeCd string? - A legacy sub-type code for the policy, maintained for historical or compatibility purposes.
- pLLineSelectedInd boolean? - Indicator of whether personal lines coverage is selected, identifying if the policy includes insurance products designed for individuals and families, such as personal auto, homeowners, or personal umbrella coverage.
- payPlanCd string? - The code identifying the payment plan associated with the policy, dictating the schedule and method of premium payments.
- paymentDay string? - Specifies the day of the month on which recurring payments are due for the policy.
- policySource string? - Identifies the origin of the policy, such as an online application, agent submission, or broker referral.
- policyType string? - Defines the type of insurance policy, such as auto, homeowners, commercial, etc., categorizing the policy for administrative and product-specific purposes.
- previousCarrierCd string? - The code of the insurance carrier that issued the previous policy, used for history tracking and risk assessment.
- previousExpirationDt string? - The expiration date of the policyholder's previous insurance policy, important for underwriting and continuity of coverage considerations.
- previousPolicyNumber string? - The policy number of the policyholder's previous insurance policy, used for reference and transferring information.
- previousPremium string? - The premium amount paid for the previous policy period, used for underwriting and pricing analysis.
- productTypeCd string? - The code representing the specific insurance product type, facilitating product management and policy administration.
- productVersionIdRef string? - A reference to the version ID of the insurance product, ensuring that the policy aligns with the correct product specifications and terms.
- programCd string? - The code identifying the insurance program under which the policy is issued, often related to specialized markets or groupings of policies.
- promotionCd string? - The code for any promotional offers or discounts applied to the policy, used for marketing and billing purposes.
- providerRef string? - A reference identifier for the provider or originator of the policy, such as an agent, broker, or direct application system.
- renewalProviderRef string? - A reference identifier for the provider managing the renewal of the policy, which may differ from the original issuing provider.
- renewalSubProducerCd string? - The code for the sub-producer responsible for the renewal of the policy, part of the distribution channel management.
- renewalTermCd string? - The code representing the term for the policy renewal, dictating the duration and conditions for the renewed coverage period.
- sessionLink string? - A URL or identifier linking to the session or transaction where the policy was created or modified, for audit and tracking purposes.
- sicCode string? - The Standard Industrial Classification (SIC) code associated with the policyholder's primary business activity, used for underwriting and risk assessment.
- subProducerCd string? - The code identifying the sub-producer or agent responsible for the policy, part of the distribution and sales network.
- subTypeCd string? - A more specific classification within the overall policy type, providing further detail on the coverage or policy structure.
- transactionCd string? - The code representing the type of transaction (e.g., new business, renewal, endorsement) that the policy record is associated with.
- transactionNumber int? - A unique identifier for the transaction involving the policy, used for tracking and auditing purposes.
- transactionStatus string? - Indicates the current status of the policy transaction, such as pending, completed, or canceled.
- transactionHistory TransactionDetails[]? - Detailed information on the previous transactions in this policy.
- umbrellaPolicyInfo UmbrellaPolicyInfo? - Encapsulates detailed information regarding an umbrella insurance policy within the Guidewire InsuranceNow system. This schema is designed to capture and organize key identifiers and attributes of an umbrella policy, facilitating effective policy management, identification, and reference across the platform. It serves as a foundational element for operations such as policy lookup, modification, and integration with related insurance processes, ensuring a coherent and unified approach to managing umbrella policies.
- underwriterCd string? - The code identifying the underwriter responsible for the policy, critical for risk management and policy approval processes.
- underwritingHoldInd boolean? - Indicator of whether the policy is currently on hold due to underwriting review, awaiting additional information or decision.
- vandalismMaliciousMischiefInd boolean? - Indicator of whether the policy includes coverage for vandalism and malicious mischief, protecting against specific types of property damage.
- wcARDRuleEnabled boolean? - Indicator of whether the workers' compensation Average Rate Differential (ARD) rule is enabled, affecting premium calculations.
- wcAnniversaryRatingDay string? - The day on which the workers' compensation policy's rating and premium are reassessed annually, important for policy management and pricing.
- wcPremiumDiscountTableTypeCd string? - The code for the type of premium discount table applied to the workers' compensation policy, affecting discounts for larger premium volumes.
guidewire.insnow: BusinessInfo![](/images/permalink.svg)
Details the business-related aspects of a party, including financial, operational, and classification information, tailored for commercial insurance contexts.
Fields
- annualPayrollAmt string? - The total amount of payroll paid annually by the business, a factor in workers' compensation and liability coverages.
- annualSalesAmt string? - The total annual sales or revenue generated by the business, influencing coverage needs and premium calculations.
- businessInfoCd string? - A code categorizing the business information record for internal tracking and management.
- businessTypeCd string? - A code indicating the type of business, such as corporation, sole proprietorship, or partnership, relevant for underwriting and policy customization.
- id string? - A unique identifier for the business information record within the system, facilitating accurate reference and management.
- natureBusinessCd string? - A code describing the nature of the business, used for classification and risk assessment purposes.
- natureOfBusiness string? - A textual description of the business's primary operations, providing context for underwriting and coverage considerations.
- numberEmployees string? - The number of employees working for the business, impacting liability exposures and coverage requirements.
- yearsInBusiness string? - The total number of years the business has been operational, indicating stability and experience in its field.
guidewire.insnow: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
guidewire.insnow: CompositeFile![](/images/permalink.svg)
Represents the details of a composite file, which is typically created by combining multiple files or parts of files into a single file attachment. This schema facilitates the management and assembly of such files.
Fields
- fileName string? - Specifies the storage path and the unique filename under which the component file is saved on the server. These files are intended to be combined to form a composite attachment.
- id string? - A unique identifier for the composite file component, allowing for precise reference and manipulation within the system.
guidewire.insnow: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|CredentialsConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
guidewire.insnow: Contact![](/images/permalink.svg)
Details a contact entity, capturing essential identification, type, and communication preferences, facilitating targeted and effective interactions.
Fields
- contactTypeCd string? - A code that categorizes the contact by their relationship or role, such as 'Agent', 'Insured', or 'Claimant', aiding in context-specific communication and processes.
- id string? - A unique identifier for the contact within the system, enabling precise reference and management.
- partyInfo PartyInfo? - Encapsulates comprehensive information about a party involved in the insurance process, including personal, business, and contact details, facilitating holistic management and communication.
- preferredDeliveryMethod string? - Specifies the contact's preferred method for receiving communications, such as 'Email', 'Paper Mail', or 'SMS', ensuring compliance with their preferences.
- status string? - Indicates the current status of the contact within the system, such as 'Active' or 'Inactive', reflecting their availability for communication and transactions.
guidewire.insnow: Country![](/images/permalink.svg)
Contains detailed information about a single country, including its ISO code and the full country name. This schema is crucial for ensuring accurate country representation and selection across the application.
Fields
- isoCd string? - The ISO 3166-1 alpha-2 code of the country, providing a two-letter code that is universally recognized for representing country names.
- name string? - The official name of the country as recognized internationally. This name is used for display purposes and in user interfaces.
guidewire.insnow: CustomerInfo![](/images/permalink.svg)
Captures essential identification and reference information for a customer, supporting customer management, service, and correspondence within the insurance system.
Fields
- customerNumber string? - A unique identifier or number assigned to the customer, serving as a primary reference for account management, policy administration, and customer service activities.
- customerRef string? - A reference string or identifier that links the customer to external systems, records, or databases, enhancing interoperability and data cohesion.
- id string? - The system-generated unique identifier for the customer's record, ensuring the ability to uniquely identify, track, and manage customer information within the system.
- name string? - The full name of the customer as registered or recognized within the system, facilitating personalization, correspondence, and customer engagement.
guidewire.insnow: Document![](/images/permalink.svg)
Detailed metadata and properties associated with a specific document, including access permissions, document type, and identifiers.
Fields
- _links Link[]? - Hypermedia links related to the document, providing navigational paths to related data and actions available for the document.
- addDt string? - The date the document was added to the system, typically in ISO 8601 format.
- addTm string? - The time the document was added to the system, often complementing the addition date for precise tracking.
- addUser string? - Identifier of the user who added the document, useful for audit trails and permissions management.
- canDeleteInd boolean? - Indicator of whether the document can be deleted, based on current user permissions and document status.
- canViewInd boolean? - Indicator of whether the current user has permissions to view the document, ensuring compliance with access control policies.
- deliveryCd string? - Code representing the delivery method or status of the document, such as electronic, mailed, or pending.
- description string? - A brief description or summary of the document's content or purpose, aiding in identification and categorization.
- documentTypeCd string? - A code categorizing the document by type, such as policy, claim, or identification, for systematic organization.
- filename string? - The name of the file as stored within the system, including file extension, facilitating file retrieval and management.
- formCd string? - A code identifying the form associated with the document, relevant in contexts where documents are generated from standardized forms.
- itemDescription string? - Detailed description of the item or content covered by the document, providing additional context beyond the basic description.
- itemName string? - The name or title of the item or subject matter the document pertains to, offering a quick reference to the document's focus.
- name string? - The title or name of the document, used as a primary identifier in listings and searches.
- outputNumber string? - A unique number or identifier generated during the document's output or creation process, useful for tracking and reference.
- ref string? - A general reference field that could be used to link the document to other entities or identifiers within the system.
- templateIdRef string? - Reference to the template used for generating the document, linking the document to its source for replication or audit purposes.
- transactionNumber string? - A unique identifier for the transaction that resulted in the document's creation or modification, essential for traceability.
- 'type string? - General categorization of the document, possibly overlapping with documentTypeCd but allowing for broader classification.
guidewire.insnow: DocumentDetail![](/images/permalink.svg)
Outlines detailed information about a document, including its description, associated files, and metadata, supporting comprehensive document management and access.
Fields
- compositeFile CompositeFile[]? - A collection of files that comprise the document, accommodating multi-part documents or attachments.
- description string? - A textual summary of the document's content or purpose, aiding in identification and categorization.
- eraseInfo EraseInfo? - Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations.
- filename string? - The name of the file as stored within the system, including extension, facilitating file identification and access.
- id string? - A unique identifier for the document, ensuring unambiguous reference across the system.
- linkReferences LinkReference[]? - Links connecting the document to related entities or records, promoting interconnectedness and contextual awareness.
- memo string? - An accompanying memo providing further detail or context about the document, enhancing understanding or guiding action.
- purgeInfo record {}? - Details the criteria and processes for purging the document from the system, aligning with data governance practices.
- tags Tag[]? - Tags applied to the document for categorization, searchability, and thematic association.
- templateId string? - The identifier of the template utilized for the document, indicating conformity to specific formats or standards.
guidewire.insnow: Driver![](/images/permalink.svg)
Detailed representation of a driver or potential driver, encompassing personal information, contact details, associated addresses, and other relevant information that pertains to their role and status within insurance policies.
Fields
- _links Link[]? - A collection of hypermedia links related to the driver, providing quick access to related resources and actions such as fetching detailed information or initiating workflows.
- _revision string? - A versioning identifier used to manage concurrent updates to the driver resource, ensuring data integrity through optimistic locking mechanisms.
- addresses Address[]? - An array of Address objects that detail the driver's associated addresses, including home, mailing, and potentially other types of addresses.
- driverInfo DriverPersonalInfo? - Captures comprehensive personal and professional details about a driver, including driving history, license information, and eligibility for various insurance benefits based on driving qualifications and courses completed.
- emailInfo EmailInfo? - Details an individual's email contact information, including type and preference status, facilitating communication and documentation processes.
- eraseInfo EraseInfo? - Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations.
- futureStatusCd string? - A code indicating the anticipated future status of the driver with respect to the policy, such as pending renewal or cancellation.
- id string? - A unique identifier for the driver, used to reference and manage driver information within the system.
- issues Issue[]? - A list of issues or points of concern related to the driver, such as incidents or violations, that may affect insurance considerations.
- locationIdRef string? - A reference to the geographical location or area associated with the driver, potentially relevant for policies with geographical considerations such as Personal Umbrella policies.
- nameInfo NameInfo? - Captures comprehensive details about an individual's or entity's name, accommodating various name formats and types to support a wide range of commercial and personal naming conventions.
- partyTypeCd string? - A categorization field that identifies the nature of the party's relationship to the policy or entity, with 'ContactParty' denoting direct contact or relation.
- personInfo PersonInfo? - Encapsulates a comprehensive set of personal details for an individual, covering demographic information, contact preferences, professional background, and licensing history, facilitating tailored interactions and personalized insurance services.
- phoneInfo PhoneInfo[]? - An array detailing the phone contact information associated with the driver, facilitating various forms of communication.
- questionReplies QuestionReplies? - Encapsulates responses to a set of predefined questions, typically used in underwriting or claim processes, to gather necessary information in a structured format.
- status string? - Current status of the driver, indicating their active involvement or any flags such as 'Deleted' for removed records.
- underLyingPartyInfoIdRef string? - References detailed party information, linking the driver to additional contextual data or policy-related entities.
- underLyingPolicyIdRef string? - A reference to the specific insurance policy ID that this driver is associated with, highlighting the connection to policy structures and coverages.
- yearsOfService int? - Represents the number of years the driver has been associated with the insurance provider or specific policy, possibly impacting considerations such as loyalty discounts or risk assessments.
guidewire.insnow: DriverInfo![](/images/permalink.svg)
Captures comprehensive driving-related information for an individual, including licensing details, driving history, and eligibility for discounts based on driving courses and behavior.
Fields
- accidentPreventionCourseCompletionDt string? - The date the driver completed an accredited accident prevention course, potentially qualifying for insurance discounts.
- accidentPreventionCourseInd boolean? - Indicates whether the driver has successfully completed an accident prevention course.
- assignedVehicle int? - The number of vehicles officially assigned to the driver within the policy, indicating responsibility and primary usage.
- attachedVehicleRef string? - Reference identifier for the vehicle(s) associated with the driver, linking driver information to specific vehicles covered under the policy.
- dateofHire string? - The date the driver was hired for employment, applicable when driving is a part of professional duties.
- defensiveDriverEffectiveDt string? - The start date from which defensive driving course benefits apply, reflecting eligibility for associated discounts.
- defensiveDriverExpirationDt string? - The expiration date for defensive driving course benefits, after which renewal may be required to maintain discounts.
- defensiveDriverInd boolean? - Indicates whether the driver has completed a defensive driving course, affecting insurance premiums and coverage options.
- driverInfoCd string? - A code categorizing the type of driver information record, useful for system processing and classification.
- driverPoints DriverPoint[]? - A list of points accrued by the driver for traffic violations or other infractions, impacting risk assessment and premium calculation.
- driverStartDt string? - The date the driver began driving, relevant for calculating driving experience and insurance eligibility.
- driverStatusCd string? - A code indicating the current status of the driver, such as active or suspended, which may influence policy terms and pricing.
- driverTrainingCompletionDt string? - The date on which the driver completed a formal driver training program, potentially affecting policy discounts.
- driverTrainingInd boolean? - Indicates completion of a formal driver training program, qualifying the driver for potential insurance benefits.
- driverTypeCd string? - Categorizes the driver by type, such as 'Primary' or 'Occasional', affecting policy coverage and premiums.
- excludeDriverInd string? - Specifies whether the driver is excluded from certain coverages within the policy, based on risk assessments or other factors.
- goodDriverDiscountInd boolean? - Indicates eligibility for a good driver discount, based on a history of safe driving practices.
- goodDriverInd boolean? - Affirms the driver's qualification as a good driver, impacting insurance rates and coverage eligibility.
- id string? - A unique identifier for the driver information record, ensuring distinct management within the insurance system.
- lengthTimeDriving int? - The total number of years the individual has been driving, crucial for evaluating driving experience and risk.
- licenseDt string? - The date on which the driver's license was issued, foundational for legal driving status and insurance underwriting.
- licenseNumber string? - The official number associated with the driver's license, essential for identification and record-keeping.
- licenseStatus string? - The current status of the driver's license, such as valid, suspended, or expired, directly affecting insurance eligibility.
- licensedStateProvCd string? - The code for the state or province that issued the driver's license, indicating jurisdiction and legal authority.
- matureDriverInd boolean? - Indicates recognition of the driver as a mature driver, possibly affecting insurance premiums and coverage options.
- mvrRequestInd boolean? - Indicates that a Motor Vehicle Report (MVR) has been requested for the driver, a key component in risk assessment and policy pricing.
- mvrStatus string? - The status of the driver's MVR, providing insights into driving history, violations, and overall risk profile.
- mvrStatusDt string? - The date of the last update to the driver's MVR status, important for maintaining current and accurate risk assessments.
- permanentLicenseInd boolean? - Specifies whether the driver holds a permanent driving license, as opposed to a provisional or temporary license.
- relationshipToInsuredCd string? - Describes the driver's relationship to the insured entity or individual, such as family member or employee, impacting coverage details.
- requiredProofOfInsuranceInd boolean? - Indicates whether the driver is required to provide proof of insurance, typically for legal or regulatory compliance.
- scholasticCertificationDt string? - The date the driver qualified for a discount based on scholastic achievements, relevant for young or student drivers.
- scholasticDiscountInd boolean? - Indicates eligibility for a discount based on scholastic performance, encouraging responsible behavior among student drivers.
- statusComments string? - Comments related to the driver's status, providing additional context or explanations for status assignments or changes.
- yearLicensed string? - The year in which the driver was first licensed, offering a measure of driving experience and proficiency.
- yearsExperience int? - The total number of years the driver has held a license, serving as an indicator of experience and driving history.
guidewire.insnow: DriverPersonalInfo![](/images/permalink.svg)
Captures comprehensive personal and professional details about a driver, including driving history, license information, and eligibility for various insurance benefits based on driving qualifications and courses completed.
Fields
- accidentPreventionCourseCompletionDt string? - The date the driver completed an accident prevention course, potentially qualifying them for insurance discounts.
- accidentPreventionCourseInd boolean? - Indicates whether the driver has completed an accredited accident prevention course.
- assignedVehicle int? - The total number of vehicles assigned to the driver within the policy, illustrating the extent of the driver's responsibility.
- attachedVehicleRef string? - Reference ID of the vehicle(s) attached to the driver within the policy, establishing a direct association between the driver and specific vehicles.
- dateofHire string? - The date on which the driver was officially hired or employed, relevant in contexts where driving is a professional activity.
- defensiveDriverEffectiveDt string? - The start date from which the benefits of completing a defensive driving course take effect, often related to policy discounts.
- defensiveDriverExpirationDt string? - The expiration date of the defensive driving course benefits, after which renewal may be necessary to maintain associated discounts.
- defensiveDriverInd boolean? - Indicates successful completion of a defensive driving course by the driver, which may affect insurance premiums or eligibility for certain coverage options.
- driverInfoCd string? - A code that categorizes the driver within the system, often used for internal classification and processing.
- driverNumber int? - A unique sequence number assigned to the driver, used for identification and tracking within the insurance policy.
- driverPoints DriverPoint[]? - A detailed record of points accumulated by the driver, reflecting violations, infractions, or other factors that may impact insurance rates or coverage.
- driverStartDt string? - The effective date when the driver was added to the policy, used for calculating the duration of coverage and experience.
- driverStatusCd string? - The current status of the driver, such as 'Occasional' or 'Principal', indicating their primary role or frequency of vehicle use within the policy.
- driverTrainingCompletionDt string? - The date the driver completed a formal training program, which may qualify them for additional benefits or discounts within their insurance policy.
- driverTrainingInd boolean? - A flag indicating whether the driver has undergone formal driving training, potentially influencing risk assessments and policy pricing.
- driverTypeCd string? - Classifies the driver by type, such as 'Excluded' or 'Underaged', affecting policy terms and coverage limits.
- excludeDriverInd string? - Indicates whether the driver is excluded from certain policy coverages or rating considerations, based on underwriting decisions or policy options.
- goodDriverDiscountInd boolean? - Signals that the driver qualifies for a good driver discount, based on a history of safe driving and adherence to traffic laws.
- goodDriverInd boolean? - Indicates recognition of the driver as a 'good driver', potentially affecting policy rates and eligibility for specific benefits.
- id string? - A unique identifier for the driver's personal information record within the system.
- lengthTimeDriving int? - The total number of years the driver has been actively driving, reflecting experience and potentially influencing risk profiles.
- licenseDt string? - The date on which the driver's license was issued, critical for verifying legal driving status and calculating experience.
- licenseNumber string? - The official number associated with the driver's license, essential for identity verification and records management.
- licenseStatus string? - Current status of the driver's license, such as 'Valid', 'Suspended', or 'Expired', impacting eligibility for insurance.
- licensedStateProvCd string? - The code of the state or province that issued the driver's license, indicating the jurisdiction under which the license is valid.
- matureDriverInd boolean? - Designates the driver as a 'mature driver', possibly qualifying for specific discounts based on age and experience.
- mvrRequestInd boolean? - Indicates that a Motor Vehicle Report (MVR) has been requested for the driver, a critical step in assessing driving history and risk.
- mvrStatus string? - The status of the MVR data report, providing insights into the driver's history and any potential issues or endorsements.
- mvrStatusDt string? - The date on which the MVR status was last updated, important for maintaining current and accurate driver records.
- permanentLicenseInd boolean? - Indicates whether the driver possesses a permanent driving license, as opposed to a provisional or temporary license.
- relationshipToInsuredCd string? - Specifies the driver's relationship to the insured party, such as 'Husband', 'Wife', 'Son', 'Daughter', affecting policy structure and coverages.
- requiredProofOfInsuranceInd boolean? - Signals the requirement for the driver to provide proof of insurance to the state or regulatory body, often linked to vehicle registration processes.
- scholasticCertificationDt string? - The date on which the driver qualified for a scholastic achievement discount, typically based on academic performance.
- scholasticDiscountInd boolean? - Indicates eligibility for a discount based on scholastic achievement, aimed at student drivers who maintain high academic standards.
- statusComments string? - Free-form comments that provide additional context or explanations for the driver's status, changes, or specific conditions noted in the record.
- yearLicensed string? - The year in which the driver was first licensed, offering a measure of driving experience and history.
- yearsExperience string? - The total number of years the driver has held a valid driving license, serving as an indicator of experience and proficiency.
guidewire.insnow: DriverPoint![](/images/permalink.svg)
Details the points associated with a driver, typically as a result of traffic violations or incidents. These points can impact insurance premiums and coverage.
Fields
- comments string? - Additional remarks or explanations regarding the specific points or the incident leading to the points.
- convictionDt string? - The date on which the conviction was registered, leading to points being added to the driver's record.
- directPortalIncidentId string? - A unique identifier for the incident as recorded in the direct portal, linking the points to specific events or violations.
- driverPointsNumber int? - The total number of points assigned to the driver as a result of the recorded incident or conviction.
- expirationDt string? - The date when the points are set to expire or be removed from the driver's record, following applicable laws or regulations.
- id string? - A unique identifier for the driver point record, allowing for tracking and management within the system.
- ignoreInd boolean? - Indicator of whether these points should be ignored or not considered in the driver's risk assessment, possibly due to mitigating circumstances.
- infractionCd string? - A code representing the specific infraction or violation that resulted in the points being assigned to the driver.
- infractionDt string? - The date on which the infraction occurred, crucial for determining the relevance and impact of the points over time.
- pointsChargeable int? - The number of points that are chargeable against the driver, directly affecting insurance assessments and premiums.
- pointsCharged int? - The actual number of points charged to the driver after considerations such as mitigating factors or legal adjustments.
- sourceCd string? - The source code identifying where the point data originated from, such as a state DMV or court system, ensuring traceability.
- status string? - The current status of the points, such as 'Active', 'Expired', or 'Removed', reflecting the driver's current standing.
- templateId string? - Reference to a template used for documenting or processing driver points, facilitating standardized record-keeping.
- typeCd string? - A categorization code that classifies the type of points or the nature of the infractions, aiding in analysis and reporting.
guidewire.insnow: ElectronicPaymentSource![](/images/permalink.svg)
Defines the details of an electronic payment source, such as bank account or credit card information, used for processing payments within the system. It includes both ACH (Automated Clearing House) and credit card payment methods.
Fields
- achBankAccountNumber string? - The bank account number for ACH payments, essential for direct bank transfers.
- achBankAccountTypeCd string? - A code identifying the type of bank account (e.g., checking, savings) used for ACH payments.
- achBankName string? - The name of the bank where the ACH account is held, providing necessary details for payment processing.
- achExceptionMsg string? - Message detailing any exceptions or issues encountered during the ACH payment process, useful for troubleshooting and record-keeping.
- achName string? - The name associated with the ACH account, typically the account holder's name as it appears on bank records.
- achRoutingNumber string? - The routing number for the bank account, a critical component for directing ACH payments to the correct financial institution.
- achStandardEntryClassCd string? - A code that categorizes the type of ACH transaction, conforming to standard entry class specifications for payment processing.
- agentTrustInd boolean? - Indicates whether the payment source is an agent's trust account, differentiating it from customer-owned accounts.
- carrierCd string? - Carrier code associated with the payment, identifying the insurance carrier in cases of payments facilitated by or through carriers.
- creditCardNumber string? - The number of the credit card used for payments, sensitive data that must be handled according to PCI compliance standards.
- creditCardTypeCd string? - A code indicating the type of credit card (e.g., Visa, MasterCard) used for the payment.
- customerPaymentProfileId string? - An identifier for the customer's payment profile, allowing for the reuse of stored payment information in a secure manner.
- customerProfileId string? - An identifier linking the electronic payment source to a customer profile, facilitating comprehensive customer payment management.
- eraseInfo EraseInfo? - Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations.
- id string? - A unique identifier for the electronic payment source record within the system.
- methodCd string? - A code that specifies the payment method (e.g., ACH, credit card), important for directing the payment process accordingly.
- midasId string? - An identifier used in MIDAS (Money Inflow/Disbursement Administration System) or similar systems for tracking financial transactions.
- partyInfo PartyInfo? - Encapsulates comprehensive information about a party involved in the insurance process, including personal, business, and contact details, facilitating holistic management and communication.
- paymentServiceAccountId string? - An account identifier used by the payment service provider, linking the payment transaction to external payment processing systems.
- reminderDt string? - A date indicating when a payment reminder should be sent, aiding in timely payment collection and customer notification.
- sourceName string? - The name of the payment source, providing a human-readable identifier for the payment method or account.
- sourceTypeCd string? - A code identifying the category of payment source (e.g., internal, external, third-party), useful for payment routing and management.
- statusCd string? - A code indicating the current status of the payment source, such as active, inactive, or under review, guiding its availability for use.
- action string? - Placeholder for any action related to the payment source, such as update or deletion.
- creditCardAuthorizationCd string? - Code indicating the status of credit card authorization, such as approved or declined.
- creditCardAuthorizationMessage string? - Message providing additional details regarding credit card authorization status or any associated messages.
- creditCardExpirationMonth string? - The expiration month of the credit card.
- creditCardExpirationYr string? - The expiration year of the credit card.
- creditCardHolderName string? - The name of the credit card holder as it appears on the card.
- creditCardSecurityCd string? - The security code associated with the credit card, typically found on the back of the card.
guidewire.insnow: EmailInfo![](/images/permalink.svg)
Details an individual's email contact information, including type and preference status, facilitating communication and documentation processes.
Fields
- emailAddr string? - The email address itself, providing a means of electronic communication.
- emailTypeCd string? - A code identifying the type of email address provided (e.g., personal, work), aiding in its appropriate use and categorization.
- id string? - A unique identifier for the email information record, allowing for reference and management within the system.
- preferredInd boolean? - Indicates whether this email address is the preferred contact method for the individual, prioritizing it among multiple contact options.
guidewire.insnow: EraseInfo![](/images/permalink.svg)
Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations.
Fields
- erasedBy string? - Identifier of the user or system process that performed the erasure, providing an audit trail for compliance and review.
- erasedDt string? - The date on which the data was erased, recorded in a standard format such as ISO 8601 for consistency and clarity.
- erasedInd boolean? - A boolean indicator that confirms whether the data has been successfully erased, providing a clear status update.
- erasedTm string? - The specific time at which the data was erased, complementing the date information for precise record-keeping.
- id string? - A unique identifier for the erase information record, facilitating tracking and management of erasure actions within the system.
guidewire.insnow: Error![](/images/permalink.svg)
Detailed information about an error.
Fields
- code int - The HTTP status code.
- message string - A brief description of the error.
- stackTrace string? - Information about the error stack trace.
guidewire.insnow: ESignatureInfo![](/images/permalink.svg)
Contains information related to electronic signatures, including the type of signature, recipient category, and signing methodology, facilitating digital document execution and verification.
Fields
- eSignatureTypeCd string? - A code that identifies the type of electronic signature process or technology used, such as digital signatures or clickwrap agreements.
- id string? - A unique identifier for the electronic signature information record, enabling distinct management and tracking within the system.
- recipientCd string? - A code categorizing the recipient of the document requiring an electronic signature, such as 'Insured', 'Agent', or 'Third Party'.
- signingType string? - Describes the method by which the electronic signature is captured or verified, providing details on the procedural aspects of the signing process.
guidewire.insnow: InsuranceScore![](/images/permalink.svg)
Provides details about an insurance score, including the score itself, reasons for the score, and related metadata, which is used in the underwriting and risk assessment processes.
Fields
- id string? - A unique identifier for the insurance score record, facilitating tracking and management within the system.
- insuranceScore string? - The insurance score, typically a numerical value or rating, derived from various factors and used to assess the risk associated with an insured or applicant.
- insuranceScoreReasons InsuranceScoreReason[]? - A list of reasons contributing to the insurance score, providing insight into factors influencing the score.
- insuranceScoreTypeCd string? - A code categorizing the type of insurance score, such as credit-based or claims history, indicating the basis for the scoring.
- overriddenInsuranceScore string? - If applicable, the insurance score that overrides the original score, typically resulting from manual review or additional information.
- sourceCd string? - A code indicating the source of the insurance score, such as an external credit bureau or an internal scoring system.
- sourceIdRef string? - A reference to the specific source record or identifier for the insurance score, linking to detailed source information.
- statusCd string? - The current status of the insurance score, such as 'Active' or 'Reviewed', indicating its state within the underwriting process.
guidewire.insnow: InsuranceScoreReason![](/images/permalink.svg)
Describes a specific reason contributing to an insurance score, offering explanations for adjustments or factors affecting the score.
Fields
- description string? - A textual description of the reason, explaining its impact or relevance to the insurance score.
- id string? - A unique identifier for the insurance score reason, enabling distinct management and reference.
- reasonCd string? - A code representing the specific reason affecting the insurance score, used for categorization and analysis.
guidewire.insnow: Insured![](/images/permalink.svg)
Represents an insured entity or individual within the system, encompassing both basic identification and specific insurance-related information.
Fields
- entityTypeCd string? - A code that identifies the nature of the insured entity, such as 'Individual', 'Corporation', or 'Partnership', reflecting the structure and legal status of the insured.
- id string? - A unique identifier assigned to the insured within the system, facilitating tracking, policy association, and risk assessment.
- indexName string? - A standardized name used for indexing and search purposes, often formatted to meet specific regulatory or operational requirements.
- partyInfo PartyInfo[]? - A list of PartyInfo objects associated with the insured, detailing multiple roles, relationships, or contact points as needed.
- preferredDeliveryMethod string? - The preferred method of communication or document delivery for the insured, aligning with their convenience and regulatory preferences.
- ratingBureauID string? - An identifier used by rating bureaus to classify or rate the insured, relevant in jurisdictions or lines of business where bureau ratings are applicable.
- selfInsured boolean? - Indicates whether the insured operates under a self-insurance model, relevant for certain types of coverage and risk management strategies.
- temporaryAddressOverrideInd boolean? - A flag that indicates a temporary override of the insured's standard address, useful for short-term billing or communication needs.
- wcNAICS string? - The North American Industry Classification System (NAICS) code applicable to the insured's business, used for statistical and risk assessment purposes.
- wcNCCIRiskIdNumber string? - A risk identification number assigned by the National Council on Compensation Insurance (NCCI), relevant for workers' compensation insurance.
- wcSIC string? - The Standard Industrial Classification (SIC) code for the insured's business, providing an industry-based risk indicator.
- websiteAddress string? - The official website address for the insured or their business, offering an additional contact point and information source.
- yearsInBusiness int? - The total number of years the insured has been in operation, reflecting business stability and experience for underwriting and risk assessment.
guidewire.insnow: Issue![](/images/permalink.svg)
Defines an issue related to an entity within the system, capturing details such as the type of issue, associated attributes, and descriptive messages to aid in identification and resolution.
Fields
- attributeRefs AttributeRef[]? - A collection of references to attributes associated with the issue, providing context and details that may aid in issue analysis and resolution.
- id string? - A unique identifier for the issue, enabling tracking and management within the system.
- msg string? - A descriptive message or summary of the issue, offering insight into the nature and potential impact of the problem.
- subTypeCd string? - A code further categorizing the issue within its broader type, allowing for more granular classification and handling.
- typeCd string? - The primary classification code of the issue, indicating its general category and facilitating appropriate routing and response strategies.
guidewire.insnow: Link![](/images/permalink.svg)
Represents a hypermedia link, providing navigational capabilities between related resources within the API, akin to links in web pages.
Fields
- href string? - The absolute or relative URL pointing to the linked resource, which can be used to directly access or query the target resource.
- rel string? - A descriptor that indicates the relationship of the linked resource to the current context, such as 'self', 'next', or specific action-related terms.
guidewire.insnow: LinkReference![](/images/permalink.svg)
Encapsulates a reference to a linked resource within the system, providing context and navigational properties to enhance connectivity between different entities or data models.
Fields
- description string? - Descriptive text for the link, typically generated based on templates, that explains the nature or purpose of the link in user-readable terms.
- id string? - A unique identifier for the link reference, facilitating tracking and management of links within the application.
- idRef string? - The reference ID of the target model to which this link points, establishing a clear connection between the link and its associated entity.
- modelName string? - The name of the model or entity type that is being linked to, providing clarity on the kind of resource the link references.
- status string? - Indicates the current status of the link, such as 'Active' or 'Deleted', reflecting the link's operational state within the system.
- systemIdRef string? - The system-wide unique database identifier for the target item of this link reference, used in scenarios where objects from different containers or databases are interconnected.
guidewire.insnow: ListAddress![](/images/permalink.svg)
A structured response payload containing an array of addresses. This schema facilitates the return of multiple address records in a single API response, typically used in search or list endpoints where multiple addresses need to be communicated.
Fields
- addresses Address[]? - An array of Address objects, each representing detailed information about a specific address. The structure of each Address object is defined by the Address schema.
guidewire.insnow: ListApplication![](/images/permalink.svg)
Encapsulates a response that includes a list of insurance applications, potentially spanning multiple pages, along with pagination control via a continuation identifier.
Fields
- applicationListItems Application[]? - An array of Application objects, each representing an individual insurance application with summary and detailed data.
- continuationId string? - A pagination control identifier that specifies the starting point for the next set of results, used when additional results are available beyond the current response.
guidewire.insnow: ListCountry![](/images/permalink.svg)
A structured response that enumerates all countries supported by the system. This can be used to populate selection lists or validate country data in user inputs.
Fields
- countries Country[] - An array of country objects, each representing a country supported by the system. This list includes both the ISO code and the name of each country.
guidewire.insnow: ListDocument![](/images/permalink.svg)
Encapsulates a response structure for API calls that return multiple documents, facilitating easy access to and manipulation of a collection of documents within the system.
Fields
- documentListItems Document[]? - An array of Document objects, each representing detailed information about a specific document within the system.
guidewire.insnow: ListDriver![](/images/permalink.svg)
Encapsulates a paginated response structure that contains a list of drivers, including relevant metadata to handle continuation of listing if more drivers exist beyond the current response set.
Fields
- continuationId string? - A unique identifier that can be used to request subsequent pages of drivers. This value represents the row index from which the next set of results should start, facilitating pagination in client applications.
- drivers Driver? - Detailed representation of a driver or potential driver, encompassing personal information, contact details, associated addresses, and other relevant information that pertains to their role and status within insurance policies.
guidewire.insnow: ListNote![](/images/permalink.svg)
Encapsulates a response that includes a list of notes associated with a specific entity, such as a policy or claim, providing a structured overview of textual annotations or reminders.
Fields
- noteListItems Note[]? - An array of Note objects, each representing an individual note with details such as content, priority, and status.
guidewire.insnow: ListPolicy![](/images/permalink.svg)
Provides a paginated structure for listing policies, facilitating the retrieval of policy information in a segmented manner. This schema supports operations that require the listing of multiple policies, including search results and batch processing views.
Fields
- continuationId string? - If more results are available, the ContinuationId should be the row index of the next row
- policyListItems Policy[]? - An array of policy items, each containing detailed information about individual policies.
guidewire.insnow: NameInfo![](/images/permalink.svg)
Captures comprehensive details about an individual's or entity's name, accommodating various name formats and types to support a wide range of commercial and personal naming conventions.
Fields
- commercialName string? - The official commercial name of an entity, used in business contexts and legal documents.
- commercialName2 string? - An additional commercial name field, allowing for legal aliases or alternative business names.
- dbaIndexName string? - Index name under which the business is filed 'Doing Business As' (DBA), facilitating accurate identification and indexing.
- dbaName string? - The 'Doing Business As' (DBA) name, representing the trading name under which the business or entity operates publicly, distinct from the legal business name.
- extendedName string? - An extended version of the name that may include additional identifiers or descriptive information, enhancing clarity and specificity.
- givenName string? - The individual's first name or given name, used in personal identification.
- id string? - A unique identifier for the name information record, ensuring trackability and distinct management within the system.
- indexName string? - A standardized name format used for indexing, typically following conventions to facilitate sorting and retrieval.
- nameTypeCd string? - A code that categorizes the type of name record, such as 'ContactName', indicating the context or application of the name information.
- otherGivenName string? - An additional or middle given name of the individual, providing completeness to personal identification.
- positionCd string? - A code representing the individual's position or title within an organization, if applicable, contributing to formal identification and correspondence.
- prefixCd string? - A prefix code indicating titles or honorifics preceding the name, such as 'Mr.', 'Dr.', or 'Ms.', contributing to respectful and accurate address.
- shortName string? - A shortened or informal version of the name, used for ease of communication or in less formal contexts.
- suffixCd string? - A suffix code indicating qualifiers or titles following the name, such as 'Jr.', 'Sr.', or academic credentials, adding to the formal identification of the individual.
- surname string? - The individual's last name or family name, essential for personal identification and official documentation.
guidewire.insnow: Note![](/images/permalink.svg)
Represents a detailed record of a note, capturing contextual comments, priority, and administrative metadata, aiding in communication and documentation processes.
Fields
- addDt string? - The date when the note was initially added to the system, providing a temporal context for the information.
- addTm string? - The precise time of day when the note was added, complementing the date for accurate chronological tracking.
- addUser string? - The identifier of the user who created the note, linking the note to its author for reference or follow-up.
- comments string? - Additional comments associated with the note, offering further clarification, instructions, or context.
- description string? - A brief description or summary of the note's content, providing an at-a-glance understanding of its purpose or subject matter.
- memo string? - A detailed memorandum contained within the note, elaborating on the topic, decision-making process, or action items.
- priorityCd string? - A code indicating the note's priority, such as 'High', 'Medium', or 'Low', affecting its visibility and urgency.
- ref string? - A reference identifier linking the note to related records or entities, enhancing data connectivity and retrieval.
- status string? - The current status of the note, such as 'Active', 'Completed', or 'Cancelled', reflecting its relevance and actionability.
- stickyInd boolean? - A boolean indicator specifying whether the note is marked as 'sticky' or particularly important, ensuring prominence in listings or displays.
- templateId string? - An identifier for a note template that was used as a basis for this note, standardizing the format and content for specific types of annotations.
guidewire.insnow: NoteDetail![](/images/permalink.svg)
Provides an in-depth view of a note, including its content, priority, and associated metadata, facilitating detailed documentation and tracking within the system.
Fields
- description string? - A brief overview or summary of the note's content, providing insight into its purpose and significance.
- eraseInfo EraseInfo? - Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations.
- id string? - A unique identifier assigned to the note, enabling distinct tracking and retrieval within the system.
- linkReferences LinkReference[]? - A collection of references linking the note to other related records or documents, enhancing contextual understanding and data integration.
- memo string? - An extended memo or detailed commentary associated with the note, providing additional context, explanations, or action items.
- priorityCd string? - A code indicating the note's priority level, such as 'High', 'Medium', or 'Low', guiding attention and response urgency.
- purgeInfo record {}? - Details regarding the conditions and policies for purging the note from the system, ensuring data management compliance.
- showOnAllProducerContainersInd boolean? - Indicates whether the note should be visible across all producer containers, ensuring broad visibility when necessary.
- stickyInd boolean? - Specifies whether the note is marked as 'sticky' or important, warranting prominent display or special attention.
- tags Tag[]? - A set of tags categorizing or highlighting aspects of the note, facilitating organization and thematic grouping.
- templateId string? - Identifier for the template used in creating the note, standardizing format and content for specific types of notes.
guidewire.insnow: PartyInfo![](/images/permalink.svg)
Encapsulates comprehensive information about a party involved in the insurance process, including personal, business, and contact details, facilitating holistic management and communication.
Fields
- addresses Address[]? - A list of addresses associated with the party, detailing physical locations for billing, correspondence, or property coverage.
- businessInfo BusinessInfo? - Details the business-related aspects of a party, including financial, operational, and classification information, tailored for commercial insurance contexts.
- driverInfo DriverInfo? - Captures comprehensive driving-related information for an individual, including licensing details, driving history, and eligibility for discounts based on driving courses and behavior.
- eSignatureInfo ESignatureInfo? - Contains information related to electronic signatures, including the type of signature, recipient category, and signing methodology, facilitating digital document execution and verification.
- emailInfo EmailInfo? - Details an individual's email contact information, including type and preference status, facilitating communication and documentation processes.
- eraseInfo EraseInfo? - Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations.
- id string? - A unique identifier for the party record within the system, ensuring accurate reference and integration across processes.
- locationIdRef string? - Reference to a specific location associated with the party, often used for underwriting or claims purposes.
- nameInfo NameInfo? - Captures comprehensive details about an individual's or entity's name, accommodating various name formats and types to support a wide range of commercial and personal naming conventions.
- partyTypeCd string? - A code indicating the type of party (e.g., individual, corporation), aiding in classification and process differentiation.
- personInfo PersonInfo? - Encapsulates a comprehensive set of personal details for an individual, covering demographic information, contact preferences, professional background, and licensing history, facilitating tailored interactions and personalized insurance services.
- phoneInfo PhoneInfo[]? - A collection of phone numbers for the party, covering different types, purposes, and preferences.
- questionReplies QuestionReplies? - Encapsulates responses to a set of predefined questions, typically used in underwriting or claim processes, to gather necessary information in a structured format.
- status string? - The current status of the party within the system, reflecting activity, eligibility, or compliance states.
- taxInfo TaxInfo? - Encapsulates tax identification information for an individual or entity, including tax ID numbers, legal entity classification, and documentation status, essential for compliance and financial reporting.
- underLyingPartyInfoIdRef string? - A reference to underlying party information, linking related records or entities within the system.
- underLyingPolicyIdRef string? - A reference to an underlying policy associated with the party, establishing connections for coverage, claims, or account management.
- yearsOfService int? - The number of years the party has been associated with services or policies within the system, indicating tenure or loyalty.
guidewire.insnow: PersonInfo![](/images/permalink.svg)
Encapsulates a comprehensive set of personal details for an individual, covering demographic information, contact preferences, professional background, and licensing history, facilitating tailored interactions and personalized insurance services.
Fields
- age int? - The current age of the individual, crucial for assessing eligibility and risk factors for certain insurance products.
- ageLicensed int? - The age at which the individual was first licensed to drive, providing insight into driving experience and proficiency.
- bestTimeToContact string? - Preferred time for contacting the individual, ensuring communications are made at convenient times, enhancing customer service.
- bestWayToContact string? - Preferred method of contact (e.g., email, phone, text), allowing for personalized communication strategies.
- birthDt string? - The individual’s date of birth, in a standard format such as ISO 8601, foundational for many aspects of insurance processing and decision-making.
- educationCd string? - A code representing the highest level of education attained by the individual, which may influence insurance rates or eligibility for certain benefits.
- employerCd string? - A code identifying the individual’s employer, useful in policies where employment status or employer partnerships affect coverage options.
- genderCd string? - The individual's gender as officially recorded, relevant in contexts where gender may impact insurance analytics or product offerings.
- id string? - A unique identifier for the person's information record, ensuring accurate tracking and updating of personal details within the system.
- maritalStatusCd string? - A code indicating the marital status of the individual, which can be a factor in policy rates and coverage options.
- occupationCd string? - A code that classifies the individual's occupation, providing risk assessment data and potential eligibility for occupation-based discounts.
- occupationClassCd string? - Further classification of the individual’s occupation, offering nuanced insight into professional risks and coverage needs.
- personTypeCd string? - Indicates the context or category of personal information provided, with 'ContactPersonal' denoting a direct, personal contact type.
- positionTitle string? - The professional title or role of the individual within their place of employment, relevant for understanding socioeconomic factors and occupational risks.
- yearsLicensed int? - The total number of years the individual has been licensed to drive, a direct measure of driving experience.
guidewire.insnow: PhoneInfo![](/images/permalink.svg)
Details an individual's or entity's phone contact information, including type and preference, to support effective and preferred modes of communication.
Fields
- id string? - A unique identifier for the phone information record, allowing for efficient tracking and management within the system.
- phoneName string? - A label or name associated with the phone number, such as 'Home' or 'Work', to identify the phone number's context or usage.
- phoneNumber string? - The actual phone number, formatted according to local or international standards, facilitating contact.
- phoneTypeCd string? - A code that categorizes the type of phone number (e.g., mobile, home, work), aiding in its appropriate use and prioritization.
- preferredInd boolean? - Indicates whether this phone number is the preferred method of contact, prioritizing it among multiple contact options.
guidewire.insnow: Policy![](/images/permalink.svg)
Represents a comprehensive view of an insurance policy, including customer details, policy specifics, associated contacts, and system references. It's designed to encapsulate all relevant information about a policy, facilitating easy access and management within the system.
Fields
- _links Link[]? - Hypermedia links associated with the policy item, providing navigational URLs to related resources.
- customerInfo CustomerInfo? - Captures essential identification and reference information for a customer, supporting customer management, service, and correspondence within the insurance system.
- policyMini PolicyMini? - Provides a condensed overview of policy information, including key attributes and links for deeper exploration.
- productInfo ProductInfo? - Provides key details about an insurance product, including its identification and descriptive name, facilitating product-specific processing and categorization.
- ref string? - A general reference identifier for the policy item, usable for cross-referencing or linkage.
guidewire.insnow: PolicyDetails![](/images/permalink.svg)
Encapsulates detailed information about an individual policy, including identification, related entities, and status indicators. This schema serves as a comprehensive model for policy information, integrating with both internal and external systems for full lifecycle management.
Fields
- _links Link[]? - Hypermedia links associated with the policy item, providing navigational URLs to related resources.
- _revision string? - The revision identifier of the policy, used for tracking changes and ensuring data consistency.
- accountRef string? - A reference identifier linking the policy to a specific account in the system.
- auditAccountRef string? - Reference identifier for the account associated with any audits related to the policy.
- basicPolicy BasicPolicy? - Summarizes foundational information about a policy, including its identification, associated affinity group, and details about its payment plan.
- contacts Contact[]? - A collection of contacts related to the policy, including individuals and entities with various roles.
- customerRef string? - A reference identifier for the customer associated with the policy.
- externalSystemInd string? - Indicator flag signifying if the policy is synchronized with an external system.
- iVANSCheck string? - Status of the IVANS check for the policy, indicating connectivity and data exchange success with the IVANS network.
- id string? - The unique identifier of the policy within the system.
- insured Insured? - Represents an insured entity or individual within the system, encompassing both basic identification and specific insurance-related information.
- statementAccountRef string? - Reference identifier for the account associated with billing statements for the policy.
- systemId string? - An identifier for the policy within the internal or external systems, facilitating cross-reference.
- updateCount int? - A counter indicating the number of times the policy has been updated.
- updateTimestamp string? - The timestamp of the last update made to the policy, formatted in ISO 8601.
- updateUser string? - Identifier of the user who last updated the policy, used for audit trails and accountability.
- version string? - The version number of the policy, used for version control and history tracking.
- vipLevel string? - The VIP level assigned to the policy or policyholder, indicating priority or special handling requirements.
- wcAdditionalInsureds WCAdditionalInsured[]? - List of additional insured entities for workers' compensation policies, detailing parties other than the primary insured that receive coverage.
- wcCoveredStates WCCoveredState[]? - A list of states in which workers' compensation coverage is included within the policy as proposed by this quote, reflecting multi-state operations and compliance.
guidewire.insnow: PolicyMini![](/images/permalink.svg)
Provides a condensed overview of policy information, including key attributes and links for deeper exploration.
Fields
- _links Link[]? - A collection of hypermedia links to related resources, facilitating navigation and further actions.
- accountRef string? - Reference identifier to the account associated with this policy, linking to account-specific details.
- auditAccountRef string? - Reference to the audit account, if applicable, providing a connection to audit-related information and actions.
- basicPolicy BasicPolicy? - Summarizes foundational information about a policy, including its identification, associated affinity group, and details about its payment plan.
- contacts Contact[]? - An array of contacts related to the policy, detailing individuals or entities associated in various capacities.
- customerRef string? - A reference to the customer associated with the policy, enabling linkage to detailed customer information.
- externalSystemInd string? - Indicator for the association of the policy with an external system, highlighting integrations or external dependencies.
- iVANSCheck string? - Result or status from an IVANS insurance verification process, reflecting verification outcomes.
- id string? - Unique identifier for the policy, facilitating identification and retrieval within the system.
- insured Insured? - Represents an insured entity or individual within the system, encompassing both basic identification and specific insurance-related information.
- statementAccountRef string? - Reference to the statement account related to the policy, used for financial transactions and billing.
- systemId string? - System identifier that manages or tracks the policy, indicating the source or platform of policy management.
- version string? - Version identifier for the policy information, denoting the format or structure level of the policy data.
- vipLevel string? - Indicates the VIP level of the policy or associated customer, used for service prioritization or benefits.
guidewire.insnow: ProductInfo![](/images/permalink.svg)
Provides key details about an insurance product, including its identification and descriptive name, facilitating product-specific processing and categorization.
Fields
- id string? - A unique identifier for the insurance product, enabling precise reference and retrieval within the system.
- name string? - The descriptive name of the product as defined in the Product Master, providing a human-readable identifier that may correspond to marketing or regulatory naming conventions.
guidewire.insnow: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
guidewire.insnow: QuestionReplies![](/images/permalink.svg)
Encapsulates responses to a set of predefined questions, typically used in underwriting or claim processes, to gather necessary information in a structured format.
Fields
- id string? - A unique identifier for the collection of question and replies, facilitating organization and retrieval.
- questionReply QuestionReply[]? - An array of responses to specific questions, each containing the question's details and the provided reply, structured according to the QuestionReply schema.
- questionSourceMDA string? - Metadata or identifier indicating the source or context of the questions, such as a specific underwriting guideline or claim process step.
guidewire.insnow: QuestionReply![](/images/permalink.svg)
Encapsulates both a specific question posed within the system and the corresponding reply, facilitating the structured collection of information for processes such as underwriting or claim assessment.
Fields
- displayDesc string? - A descriptive label or prompt for the question, intended to be displayed as part of the question when presented to the user.
- id string? - A unique identifier for the question and reply instance, allowing for tracking and referencing within the system.
- name string? - The name or key identifying the question, which may be used to map the reply to specific processes or data fields.
- text string? - The full text of the question as presented to the user, detailing what information or response is being requested.
- value string? - The reply or response provided to the question, stored as a string regardless of the original format or type of the input.
- visibleInd boolean? - Indicates whether the question is currently set to be visible to the user, allowing for conditional display based on context or previous answers.
guidewire.insnow: Quote![](/images/permalink.svg)
Encapsulates comprehensive details about a quotation for insurance coverage, including linked resources, policy information, and the status of the quote.
Fields
- _links Link[]? - A collection of hypermedia links to related resources and actions available for the quote, facilitating easy navigation and interaction within the API ecosystem.
- _revision string? - A system-generated version identifier for the quote, used to manage updates and ensure data integrity through optimistic concurrency control.
- applicationInfo ApplicationInfo? - Encapsulates a detailed record of an insurance application's lifecycle within the system, tracking its creation, updates, mailing history, closure, and any related correction or reinstatement transactions.
- basicPolicy BasicPolicy? - Summarizes foundational information about a policy, including its identification, associated affinity group, and details about its payment plan.
- contacts Contact[]? - A list of contacts associated with the quote, including individuals or entities involved in the policy as insureds, beneficiaries, or other roles.
- customerRef string? - A reference identifier linking the quote to a customer record, enabling correlation between customer details and quotation data.
- description string? - A brief description or summary of the quote, providing insights into the coverage scope, purpose, or specific considerations.
- externalStateData string? - External system data related to the quote, potentially including state-specific requirements, third-party data, or external identifiers.
- id string? - The unique identifier for the quote, facilitating tracking, management, and retrieval within the system.
- insured Insured? - Represents an insured entity or individual within the system, encompassing both basic identification and specific insurance-related information.
- lockTaskId string? - An identifier for a system task or process that has locked the quote for exclusive access, preventing concurrent modifications.
- policyRef string? - A reference identifier linking the quote to a specific policy or policy proposal, establishing a connection between quoting and policy issuance.
- statementAccountRef string? - A reference to the statement account associated with this quote, used for billing and financial transactions related to the policy.
- status string? - The current status of the quote, indicating its progression through the quoting process, approval state, or any conditions affecting its validity.
- submitterIssues SubmitterIssue[]? - A list of issues or concerns raised by the submitter or system during the quoting process, requiring attention or resolution before proceeding.
- transactionInfo TransactionInfo? - Captures detailed information related to a specific transaction within the policy lifecycle, including cancellations, corrections, payments, and policy term adjustments, among others.
- vipLevel string? - Indicates the VIP level or priority of the quote, which may affect processing speed, service levels, or access to special pricing.
- wcAdditionalInsureds WCAdditionalInsured[]? - List of additional insured entities for workers' compensation policies, detailing parties other than the primary insured that receive coverage.
- wcCoveredStates WCCoveredState[]? - A list of states in which workers' compensation coverage is included within the policy as proposed by this quote, reflecting multi-state operations and compliance.
guidewire.insnow: ReapplyOutputSuppression![](/images/permalink.svg)
Specifies settings for reapplying output suppression rules to a transaction, indicating whether certain communications or document outputs should be included or suppressed based on specific criteria.
Fields
- id string? - A unique identifier for the output suppression rule, enabling tracking and management of suppression settings.
- includeInd boolean? - Indicates whether the suppression rule should be included in the current transaction, determining if related outputs are generated.
guidewire.insnow: StateProvinces![](/images/permalink.svg)
Defines the attributes of a state or province, providing key identifiers and names for use in addressing and location services within the insurance application.
Fields
- id string? - The unique identifier or code for the state or province, often used as a standard abbreviation or code in address formats.
- stateProvName string? - The full name of the state or province, providing a clear and unambiguous reference for users and systems interacting with address information.
guidewire.insnow: SubmitterIssue![](/images/permalink.svg)
Encapsulates issues identified by the submitter during the insurance application or quote submission process, including categorization and descriptive messaging.
Fields
- id string? - A unique identifier for the submitter issue, facilitating tracking and resolution efforts within the system.
- msg string? - A descriptive message detailing the nature of the issue, providing insight into potential concerns or required actions.
- subTypeCd string? - A code further specifying the subtype of the issue, offering additional granularity beyond the primary type for more precise categorization.
- typeCd string? - The primary classification code for the issue, indicating its general category and aiding in prioritization and resolution strategies.
guidewire.insnow: Tag![](/images/permalink.svg)
Encapsulates metadata in the form of a tag, allowing for the categorization, organization, and easy retrieval of various entities within the system. Tags can be applied to documents, contacts, claims, and more, facilitating efficient data management and searchability.
Fields
- id string? - A unique identifier for the tag, ensuring distinctness across the system and enabling precise reference and operations on the tag.
- name string? - The human-readable name of the tag, which succinctly describes the attribute, category, or keyword associated with the tag. This name is used for displaying, searching, and organizing entities tagged with this label.
- tagTemplateIdRef string? - The reference ID to a predefined tag template from which this tag was created, if applicable. Tag templates facilitate the standardization of tags across the system, ensuring consistency in tagging conventions and metadata application.
guidewire.insnow: TaxInfo![](/images/permalink.svg)
Encapsulates tax identification information for an individual or entity, including tax ID numbers, legal entity classification, and documentation status, essential for compliance and financial reporting.
Fields
- fein string? - The Federal Employer Identification Number (FEIN) for the entity, used in tax filings and other legal documents as a unique identifier.
- id string? - A unique identifier for the tax information record, facilitating accurate tracking and association with parties or accounts.
- legalEntityCd string? - A code indicating the legal entity type, such as corporation, partnership, or sole proprietor, relevant for tax classification and compliance.
- received1099Ind boolean? - Indicates whether the party has received a Form 1099, used for reporting income from sources other than wages, salaries, and tips.
- receivedW9Ind boolean? - Indicates whether a Form W-9 has been received from the party, used to request the taxpayer identification number and certification.
- required1099Ind boolean? - Specifies if the issuance of a Form 1099 is required for the party, based on the nature of payments or income received.
- ssn string? - The Social Security Number (SSN) for individuals, serving as a primary identification number for tax and other legal purposes.
- taxIdTypeCd string? - A code that specifies the type of tax identification number provided, such as SSN or FEIN, indicating the format and nature of the ID.
- taxTypeCd string? - A code describing the tax classification of the party, such as 'Individual', 'Corporation', or 'Partnership', impacting tax treatment and obligations.
- withholdingExemptInd boolean? - Indicates whether the party is exempt from tax withholding, relevant for processing payments and tax reporting.
guidewire.insnow: TransactionCloseReasons![](/images/permalink.svg)
Reasons for the closure of a transaction.
Fields
- closeComment string? - Comment associated with transaction closure.
- closeReasonCd string? - Code indicating the reason for transaction closure.
- closeSubReasonCd string? - Code indicating the sub-reason for transaction closure.
- closeSubReasonLabel string? - Label associated with the sub-reason for transaction closure.
- id string? - Unique identifier for the transaction close reasons.
guidewire.insnow: TransactionDetails![](/images/permalink.svg)
Defines the details of a transaction within the system.
Fields
- applicationRef string? - Reference to the application.
- bookDt string? - Date when the transaction was booked.
- cancelOfTransactionNumber int? - Transaction number associated with the cancellation.
- cancelRequestedByCd string? - Code indicating who requested the cancellation.
- cancelTypeCd string? - Code indicating the type of cancellation.
- cancelledByTransactionNumber int? - Transaction number associated with the cancellation.
- chargeReinstatementFeeInd boolean? - Indicates whether a reinstatement fee was charged.
- checkNumber string? - Number associated with the check.
- conversionGroup string? - Group associated with conversion.
- conversionJobRef string? - Reference to the conversion job.
- conversionTemplateIdRef string? - Reference to the conversion template ID.
- correctedByTransactionNumber int? - Transaction number associated with correction.
- correctionOfTransactionNumber int? - Transaction number associated with correction.
- delayInvoiceInd boolean? - Indicates whether invoice is delayed.
- holdType string? - Type of hold.
- id string? - Unique identifier for the transaction.
- inforceChangePremiumAmt string? - Amount of change in premium for in-force policy.
- inforcePremiumAmt string? - Amount of in-force premium.
- masterTransactionNumber int? - Master transaction number.
- newPolicyEffectiveDt string? - Effective date of the new policy.
- newPolicyExpirationDt string? - Expiration date of the new policy.
- outputTypeCd string? - Code indicating the type of output.
- paymentAmt string? - Amount of payment.
- paymentTypeCd string? - Code indicating the type of payment.
- reinstatedByTransactionNumber int? - Transaction number associated with reinstatement.
- reinstatementOfTransactionNumber int? - Transaction number associated with reinstatement.
- releaseHoldReason string? - Reason for releasing hold.
- renewalApplyOfTransactionNumber int? - Transaction number associated with renewal application.
- renewalProviderRef string? - Reference to renewal provider.
- renewalSubProducerCd string? - Code indicating the sub-producer of renewal.
- replacedByTransactionNumber int? - Transaction number associated with replacement.
- replacementOfTransactionNumber int? - Transaction number associated with replacement.
- rewriteToProductVersion string? - Version of the product for rewrite.
- sourceCd string? - Code indicating the source of transaction.
- submissionNumber int? - Submission number.
- transactionCd string? - Code indicating the type of transaction.
- transactionCloseReasons TransactionCloseReasons? - Reasons for the closure of a transaction.
- transactionDt string? - Date of the transaction.
- transactionEffectiveDt string? - Effective date of the transaction.
- transactionEffectiveTm string? - Time when the transaction became effective.
- transactionLongDescription string? - Long description of the transaction.
- transactionNumber int? - Transaction number.
- transactionReasons TransactionReason[]? - Reasons associated with the transaction.
- transactionShortDescription string? - Short description of the transaction.
- transactionText TransactionText[]? - Text associated with the transaction.
- transactionTm string? - Time of the transaction.
- transactionUser string? - User associated with the transaction.
- unAppliedByTransactionNumber int? - Transaction number associated with un-application.
- unApplyOfTransactionNumber int? - Transaction number associated with un-application.
- unapplySource string? - Source of un-application.
- wcReinstatementCd string? - Code indicating the reinstatement of workers compensation.
- wcTotalNetLocationsManualPremiumAmt string? - Total net locations manual premium amount for workers compensation.
- wcWaiveCancellationAuditInd boolean? - Indicates whether cancellation audit for workers compensation is waived.
- writtenChangePremiumAmt string? - Amount of change in premium for written policy.
- writtenFeeAmt string? - Fee amount for written policy.
- writtenPremiumAmt string? - Premium amount for written policy.
guidewire.insnow: TransactionInfo![](/images/permalink.svg)
Captures detailed information related to a specific transaction within the policy lifecycle, including cancellations, corrections, payments, and policy term adjustments, among others.
Fields
- cancelOfTransactionNumber int? - Transaction number of a previous transaction that this transaction cancels or nullifies.
- cancelRequestedByCd string? - Code identifying who requested the cancellation, providing insight into the source of the transaction.
- cancelTypeCd string? - Code categorizing the type of cancellation, aiding in the processing and reporting of cancellations.
- cancelledByTransactionNumber int? - Transaction number of a subsequent transaction that cancels this one, indicating a linkage between transactions within the policy history.
- chargeReinstatementFeeInd boolean? - Indicator of whether a reinstatement fee is charged for this transaction, typically associated with policy reinstatements.
- checkNumber string? - The number of the check used for payment in this transaction, applicable for transactions involving check payments.
- correctedByTransactionNumber int? - Transaction number of a subsequent transaction that corrects this one, facilitating tracking of corrections through transaction chains.
- correctionOfTransactionNumber int? - Transaction number of a previous transaction that this one corrects, establishing a correction relationship within the transaction history.
- delayInvoiceInd boolean? - Indicator that the generation of an invoice for this transaction should be delayed, according to specific processing rules or conditions.
- electronicPaymentSource ElectronicPaymentSource? - Defines the details of an electronic payment source, such as bank account or credit card information, used for processing payments within the system. It includes both ACH (Automated Clearing House) and credit card payment methods.
- holdType string? - Specifies the type of hold placed on a transaction, impacting how the transaction is processed and when it becomes effective.
- id string? - A unique identifier for the transaction information record, ensuring distinct management and tracking within the system.
- newPolicyEffectiveDt string? - The effective date of the policy resulting from this transaction, marking the start of the new or adjusted policy term.
- newPolicyExpirationDt string? - The expiration date of the policy resulting from this transaction, indicating the end of the current policy term.
- outputTypeCd string? - Code that identifies the type of output or document generation triggered by this transaction, such as policy declarations or billing statements.
- paymentAmt string? - The amount of payment made or processed in this transaction, relevant for transactions involving financial exchanges.
- paymentTypeCd string? - Code that classifies the type of payment made, such as premium payment, reinstatement fee, or other transaction-related payment.
- reapplyOutputSuppressions ReapplyOutputSuppression[]? - A list of output suppression settings to be reapplied as a result of this transaction, affecting document generation and communication preferences.
- reinstatedByTransactionNumber int? - Transaction number of a subsequent transaction that reinstates this one, linking transactions within the context of policy reinstatements.
- reinstatementOfTransactionNumber int? - Transaction number of a previous transaction that this one reinstates, creating a connection within the reinstatement process.
- releaseHoldReason string? - The reason provided for releasing any holds associated with this transaction, facilitating administrative processing and documentation.
- renewalApplyOfTransactionNumber int? - Transaction number of a renewal application associated with this transaction, indicating continuity in the policy lifecycle.
- renewalProviderRef string? - Reference identifier for the renewal provider or system associated with this transaction, linking to external systems managing renewals.
- renewalSubProducerCd string? - Code identifying the sub-producer or agent responsible for the renewal, part of the distribution and sales tracking.
- rewriteToProductVersion string? - Specifies the product version to which the policy is being rewritten as a result of this transaction, indicating product updates or changes.
- sourceCd string? - Code that identifies the source of the transaction, such as an online portal, agent submission, or system-generated adjustment.
- transactionCd string? - A code categorizing the transaction type, facilitating processing, reporting, and historical tracking of policy transactions.
- transactionEffectiveDt string? - The effective date of the transaction, indicating when the changes or actions associated with the transaction take effect.
- transactionEffectiveTm string? - The precise time at which the transaction becomes effective, providing additional specificity beyond the effective date.
- transactionLongDescription string? - A detailed description of the transaction, offering insights into its purpose, scope, and impact on the policy or customer.
- transactionNumber int? - A system-assigned sequential number for the transaction, serving as a unique identifier within the policy's transaction history.
- transactionShortDescription string? - A brief summary of the transaction, useful for quick reference and overview in listings or summaries.
- wcReinstatementCd string? - For workers' compensation policies, a code that indicates the conditions or reasons for reinstatement following cancellation or lapse.
- wcTotalNetLocationsManualPremiumAmt string? - In workers' compensation policies, the total premium amount for manually rated locations, reflecting specific risk assessments.
- wcWaiveCancellationAuditInd boolean? - Indicates whether the audit requirement at cancellation has been waived for a workers' compensation policy, affecting end-of-term processing.
guidewire.insnow: TransactionReason![](/images/permalink.svg)
Reason associated with a transaction.
Fields
- id string? - Unique identifier for the transaction reason.
- reasonCd string? - Code indicating the reason for the transaction.
guidewire.insnow: TransactionText![](/images/permalink.svg)
Defines the structure for transaction text within the system, including its ID, textual content, associated code, and transaction text type.
Fields
- id string? - Unique identifier for the transaction text.
- text string? - Text associated with the transaction.
- textCd string? - Code associated with the text.
- transactionTextTypeCd string? - Code indicating the type of transaction text.
guidewire.insnow: UmbrellaPolicyInfo![](/images/permalink.svg)
Encapsulates detailed information regarding an umbrella insurance policy within the Guidewire InsuranceNow system. This schema is designed to capture and organize key identifiers and attributes of an umbrella policy, facilitating effective policy management, identification, and reference across the platform. It serves as a foundational element for operations such as policy lookup, modification, and integration with related insurance processes, ensuring a coherent and unified approach to managing umbrella policies.
Fields
- id string? - The unique identifier for the umbrella policy, used to uniquely distinguish this policy from others within the system.
- idRef string? - A reference identifier that links this umbrella policy to related records or entities within the system, facilitating cross-referencing and data integrity.
- policyNumber string? - The policy number assigned to the umbrella policy, serving as a human-readable identifier that is often used in documentation and communications.
guidewire.insnow: WCAdditionalInsured![](/images/permalink.svg)
Details an additional insured entity or individual on a workers' compensation policy, providing key identification and insurance-related information.
Fields
- entityTypeCd string? - A code indicating the type of entity the additional insured represents, such as 'Additional Named Insured', categorizing their role within the policy context.
- id string? - A unique identifier for the additional insured record, facilitating distinct management and reference within the system.
- indexName string? - A standardized name used for indexing and searching purposes, often formatted to meet specific operational or regulatory requirements.
- insuranceScore InsuranceScore[]? - An array of InsuranceScore objects that provide scoring or rating information related to the additional insured, used in underwriting and risk assessment.
- insuredNumber int? - A numerical identifier assigned to the additional insured, useful for tracking and differentiation from other insured entities on the policy.
- linkReference LinkReference[]? - A collection of references linking the additional insured to related records or external entities, enhancing data connectivity and context.
- partyInfo PartyInfo? - Encapsulates comprehensive information about a party involved in the insurance process, including personal, business, and contact details, facilitating holistic management and communication.
- preferredDeliveryMethod string? - Indicates the preferred method for delivering communications or documents to the additional insured, aligning with their convenience and regulatory preferences.
- status string? - The current status of the additional insured within the policy, such as 'Active' or 'Inactive', reflecting their involvement and coverage status.
guidewire.insnow: WCCoveredState![](/images/permalink.svg)
Details specific workers' compensation coverage options and conditions for a given state, including discounts, deductibles, experience modifications, and other factors influencing the policy's terms and premium calculations.
Fields
- aRDRuleEnabled boolean? - Indicates whether the Alternate Risk Distribution (ARD) rule is enabled for this state, affecting risk assessment and premium distribution.
- alcoholDrugFreeCreditInd boolean? - Indicates eligibility for a credit based on participation in alcohol and drug-free workplace programs.
- certifiedSafetyHealthProgPct string? - The percentage credit applied for participation in certified safety and health programs, encouraging workplace safety initiatives.
- coinsuranceInd boolean? - Indicates the presence of a coinsurance arrangement for the covered state, impacting the distribution of risk between insurer and insured.
- contrClassPremAdjCreditPct string? - The percentage credit applied based on adjustments to the contractor classification premium, reflecting specific risk profiles and experience.
- deductibleAmt string? - The amount of deductible applied to the policy for the covered state, influencing out-of-pocket costs before insurance coverage begins.
- deductibleType string? - Specifies the type of deductible, such as 'per claim' or 'aggregate', defining how the deductible applies within the policy terms.
- eLVoluntaryCompensationInd boolean? - Indicates whether Employers' Liability Voluntary Compensation is included, extending coverage beyond statutory workers' compensation requirements.
- experienceModificationFactor string? - A factor reflecting the insured's historical claims experience relative to the industry average, affecting premium calculations.
- experienceModificationStatus string? - Status of the experience modification, such as 'applied' or 'pending', indicating the current application of the experience factor.
- experienceRatingCd string? - A code representing the insured's experience rating, categorizing the risk level based on past claims history.
- gLScheduledPremiumMod string? - Scheduled premium modification for General Liability, affecting the overall premium calculation based on specific risk adjustments.
- id string? - A unique identifier for the workers' compensation coverage record within the specified state.
- index int? - A numerical index used for ordering or categorization within the system, facilitating data organization and retrieval.
- largeDeductibleFactor string? - A factor applied in cases of large deductibles, influencing the premium calculation by accounting for the increased self-assumed risk.
- managedCareCreditInd boolean? - Indicates the application of a credit for participation in managed care programs, reflecting cost savings from efficient care management.
- noOfContractsForWaiverOfSubrogation string? - The number of contracts under which a waiver of subrogation applies, affecting the rights of the insurer to pursue recovery from third parties.
- noncomplianceChargeAmt string? - The amount charged for noncompliance with specified conditions or requirements, serving as a penalty or incentive for adherence to policy terms.
- numberOfClaims string? - The number of claims filed under the policy for the covered state, providing a measure of risk and loss history.
- 'order int? - Specifies the order in which this state's coverage details are presented or processed, indicating sequencing within multi-state policies.
- packageFactorInd boolean? - Indicates whether package factors, combining multiple coverages or policies, are applied in premium calculations for the state.
- primaryInd boolean? - Designates the state as the primary state of coverage, relevant for policies covering multiple jurisdictions.
- productVersionIdRef string? - Reference to the product version associated with this coverage, linking state-specific terms to overall policy structure and offerings.
- ratingEffectiveDt string? - The effective date of the rating and pricing structure applied to the covered state, marking the beginning of the applicable terms.
- ruleStatus string? - Indicates the status of regulatory or internal rules applied to the coverage, such as 'active', 'pending', or 'expired'.
- stateCd string? - The code representing the state for which the coverage details apply, identifying the jurisdiction covered by the policy terms.
- status string? - The current status of the coverage for the specified state, indicating active, inactive, or pending states of the coverage terms.
- totalDiscountedPremiumAmt string? - The total premium amount after applying discounts, reflecting cost adjustments based on risk management practices or other criteria.
- totalManualPremiumAmt string? - The total premium calculated based on manual rates before application of experience modifications or other adjustments.
- totalStandardPremiumAmt string? - The standard premium amount prior to any discounts or modifications, serving as a baseline for subsequent premium calculations.
- totalStateEstimatedPremium string? - An estimate of the total premium for the covered state, considering specific state rates, classifications, and coverage requirements.
- totalSubjectPremiumAmt string? - The portion of the premium subject to adjustments and modifications, based on covered payroll, classification rates, and experience factors.
- unemploymentNumber string? - The unemployment insurance number for the insured within the covered state, relevant for businesses and compliance reporting.
- waiverOfSubrogationFlatInd boolean? - Indicates whether a flat waiver of subrogation applies, limiting the insurer's right to recover from third parties causing loss.
- workStudyProgram string? - Details about any work-study programs affecting coverage or premium calculations, relevant for educational institutions or employers.
- workfareProgramWeeksNum string? - The number of weeks covered under a workfare program, applicable for policies including workfare participants.
Import
import ballerinax/guidewire.insnow;
Metadata
Released date: 5 months ago
Version: 0.1.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.8.6
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Insurance
Guidewire
Cloud API
Contributors
Other versions
0.1.0