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.

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

v1

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

v2

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.

raw

Name	Type	Description
WorkflowStepRequest*	object	The coverage variant chosen for this claim

form-data

Key	Value	Description
file*	File	All files must have "file" as key to be processed succesfully

Types of responses

201: Created Created successfully

400: Bad Request Request contains malformed data

401: Unauthorized Invalid or expired access token

402: Payment Required Pending payment

{
    "error": "Internal validation failed",
    "details": "This workflow is already completed."
}

422: Unprocessable Entity Internal validation failed

{
    "error": "Internal validation failed",
    "details": "This workflow is already completed."
}

429: Too Many Requests API rate limit

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

200: OK Retrieved successfully

{
    "data": {
        "id": "c7bc72aa-6d0a-4958-ad09-50bd4fc9c232",
        "current_step": "step_2",
        "workflow": {
            "step_2": {
                "name": "EXAMPLE 1: Receive the form - .png",
                "inbound": {
                    "undefined": {
                        "type": "file",
                        "typeOfFile": ".png"
                    }
                }
            }
        }
    }
}

400: Bad Request Request contains malformed data

401: Unauthorized Invalid or expired access token

402: Payment Required Pending payment

422: Unprocessable Entity Internal validation failed

429: Too Many Requests API rate limit

404: Not Found User not found