This article explains how the Assure Customer API (a secure RESTful API provided by Evotix) can be used to automate the creation, update, and deletion of Claims Management records in Assure (the core Evotix EHS management platform). The API integrates with external systems such as integration platforms, ETL tools, and custom code. Using this feature requires technical expertise and is typically handled by an organisation's IT function. The API functionality must first be enabled by Evotix. This article covers: what the API can do, minimum required fields, optional fields, out-of-scope limitations, and how to get started with setup.
Cross-module scope: This workflow spans the Assure Claims Management module and the Assure System Configuration area (API Access and API key management).
Prerequisites
Before using the Assure Customer API to manage Claims Management records, confirm the following are in place:
- API access is enabled The API functionality must be enabled by the Evotix team before use. Contact your CDM (Customer Development Manager) or CSM (Customer Success Manager) to request access.
- API authentication keys are generated API keys must be created and managed in Assure under System Configuration in the API Access area before any API requests can be made. The Manage API Supervisor Privilege must be enabled before a user can access the API Access screen. Refer to the API Key Management article for instructions.
- Claims Management reference values are known The Claims Management reference field cannot be automatically assigned by the system when creating or updating records; it must be provided in all requests. Reference values must be determined and available before any API call is made.
- Caption maintenance mandatory fields are identified In addition to the standard minimum required fields (Org Unit, Reference, and Date of Incident), any other fields set as mandatory in the Claims Management caption maintenance must also be supplied in the request.
- The Claims Management module is active and configured in Assure Default reviewers and approvers must be configured in Assure where required. If there are default reviewers and approvers set up, they will be automatically applied on the creation of a record via the API.
- Technical resource is available Making use of the Customer API requires a level of technical expertise, so this is typically something that a company's IT function would handle.
Overview
The Assure Customer API can be used to automate the processes of managing Claims Management records in Assure. The API is accessed via the internet as a secure RESTful API which is widely supported by integration platforms, ETL tools, and all programming and scripting languages, so it can be easily set up to integrate with external systems.Making use of the Customer API requires a level of technical expertise, so this is typically something that a company's IT function would handle.
Important: The API functionality must be enabled by the Evotix team before use. Contact your CDM (Customer Development Manager) or CSM (Customer Success Manager) if you are interested in procuring this feature.
What the API Can Do
With the Customer API, users can:
- Create new Claims Management records
- Update existing Claims Management records
- Delete Claims Management records
Each of these operations requires the user to make a request to the Customer API. A detailed user guide and supporting API schema is available, detailing the API methods and the information required to use them.
Required and Optional Fields
Minimum Required Fields
The minimum required fields when creating or updating a Claims Management record are:
- Org Unit
- Reference
- Date of Incident
- Plus any other fields which you have set as a mandatory requirement in the Claims management caption maintenance.
Optional Fields
Other fields that can be set and will be defaulted if not supplied:
- Is this confidential
- Incident Reference
- Vehicle Incident Reference
- Type Of Claim
- Investigation Date
- Notification Date
- Description
- Location
- Locality
- Nature Of Incident
- Incident Details
- Manager
- Probability
- Stage Of Claim
- Current Position
- Outcome
- Cost Centre
Costs
- Interim Payment Date
- Settlement Date
Estimated
- Initial Reserve
- Current Reserve
- Plaintiff Costs,
- Defence Costs
- Vat
- Excess
Actual
- Interim Payment
- Plaintiff Costs
- Defence Costs
- Vat
- Excess
- Settlement Comments
Interested Parties
- Insurer Reference
- Insurer Details
- Broker Details
- Defence Solicitor
- Loss Adjuster
- Other Parties
- Broker Reference
Claimants
- Surname
- Forename
- Address1
- Address2
- Address3
- Town
- County
- Postcode
- Date Of Birth
- Date Of Death,
- Age
- Sex
- Occupation
- Shift
- Lost Time Days
- Injury Type
- Apparent Cause
- Part Of Body Affected
- Resultant Disability Or Harm
- Plaintiff Name
- Plaintiff Solicitor
Other Information
- Defence Nature
- Names Of Expert Witnesses
Negligence Or Causation Advice
- Is Internal
- Is External
- Has Exchanged Witness Reports
- Notes
Quantum Advice
- Is Internal
- Is External
- Has Exchanged Witness Reports
- Notes
- Is Complaint
- Number Of People Injured
- Is Alternative Dispute Resolution
- Alternative Resolution
- Is Structuring Feasible
- Is Acceptable To Plaintiff
Out of Scope
The following elements are currently out of scope for the Claims Management API:
- The Claims Management reference field cannot be changed via the API. Records can only be created with a unique reference, or updated where an existing record for the reference provided already exists.
- The Claims Management reference field cannot be automatically assigned by the system when creating or updating records. The reference must be provided in all requests.
- Supporting items cannot be added via the API. This includes actions, attachments, notes, reviews, and links to policies and guidance.
- If default reviewers and approvers are configured, they will be automatically applied on record creation.
- When the module reference for either an Incident or Vehicle Incident is provided, only the "Select" option is available via the API. The "Select and Copy" and "Create" options cannot be used via the API.
- Any default values set within the caption maintenance area are not taken into consideration by the API.
Setting Up the API
Getting started requires two steps:
- Request API access from Evotix Before getting started, request access from Evotix through your Customer Development Manager or Customer Success Manager.
- Create and manage API authentication keys in Assure API keys are created and managed in Assure under System Configuration in the API Access area. The Manage API Supervisor Privilege must be enabled before a user can access the API Access screen. Check out this article for details API Key Management Article
Once access is granted, refer to the following user guides:
- Assure Customer API User Guide -- covers initial setup of the Customer API
- Customer API User Guide: Claims Management API -- covers the specific setup and methods for the Claims Management API
AI Metadata
- Product Area: Assure - Claims Management, System Configuration (API Access)
- User Role: IT Administrator, Integration Engineer, Assure System Administrator
- Tags: Claims Management, Customer API, RESTful API, API integration, create record, update record, delete record, API key, caption maintenance, org unit, CDM, CSM
- Version/Region: All Assure versions; all regions
- Important Synonyms: Customer API = Assure Customer API = inbound API; Claims Management = Claims module; Org Unit = Organisational Unit; CDM = Customer Development Manager; CSM = Customer Success Manager; Caption Maintenance = field configuration settings
- Suggested Embedding Keywords: Assure Customer API Claims Management, automate claims records Assure, create claims record API, update claims Assure API, RESTful API Assure integration, Claims Management API fields, API out of scope claims, set up Assure API, Claims Management minimum required fields
- Relevant Modules and Cross-Module Implications: Claims Management (records created, updated, or deleted via the API); Assure System Configuration API Access (API key creation and management); Incident module and Vehicle Incident module (linked record references can be provided via the API using the Select option only); Actions, Attachments, Notes, Reviews, Policies and Guidance (out of scope for this API)