Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Workflows Management

This page will introduce you to workflows. But what do we mean by workflows? Workflows are the sequences of steps that certain claims go through. In other words, the process doesn't end once a claim is created. There are specific steps that must be completed.

Let's consider an example: suppose there is a theft claim. The first step is to create the claim, but then two things need to be validated—a police report confirming the theft occurred and the amount to be covered. These aspects can't be verified at the time of creating the claim because you don't have the theft report, and without it, we can't validate what will be covered.

Therefore, the claim enters a system of steps where the necessary information can be requested to fulfill the requirements, allowing for much more granular and asynchronous management of each case. This may involve agents and communication with third parties. This documentation will guide you on how to integrate workflows, always keeping in mind that this process takes place after the claim has been created.

Endpoints

Method
Endpoint

POST

https://api.insurehero.io/api/shield/v1/users/:userId

GET

https://api.insurehero.io/api/shield/v1/claims/:claimId/workflow

How to interact with a workflow

To interact with a workflow, it's necessary to know the claim ID. Therefore, we recommend understanding how claim gets work.

Post a step

POST https://app.insurehero.io/api/shield/v1/claims/:claimId/workflow

POST https://app.insurehero.io/api/shield/v2/claims

Headers

Name
Type
Description

Authorization*

string

Bearer access token

User-Authorization*

string

User unique token to create claims

Request Body

This endpoint support raw and form-data depending upon the kind of requirement of the step. To know more about what kind of data you can send use the get workflow endpoint.

Name
Type
Description

WorkflowStepRequest*

object

The coverage variant chosen for this claim

Key
Value
Description

file*

File

All files must have "file" as key to be processed succesfully

Types of responses

Get step information

Fetch the information needed to pass the step

GET https://api.insurehero.io/api/shield/v1/claims/:claimId/workflow

Path Parameters

Name
Type
Description

claimId*

string

Either user_id or uid

Headers

Name
Type
Description

Authorization*

string

Bearer access token

Attributes

Name
Type
Description (English)

data

object

Contains the workflow data.

id

uuid

Unique identifier of the workflow instance.

current_step

string

Indicates the current step in the workflow.

workflow

object

Defines the steps and their configurations.

step_2

object

Represents a specific step within the workflow.

name

string

Name of the step.

inbound

object

Defines the expected input requirements.

undefined

object

Contains details about required files or inputs.

type

string

Specifies the input type (e.g., file).

typeOfFile

string

Specifies the expected file type (e.g., .png).

PreviousClaims Asset ManagementNextIntegrations

Last updated