Create Claim

POST {{claim_api_host}}/claim

Creates a claim

The example body is the minimum required to create a claim.

Any further data will be added ass additional data. It must match one of the following structures:

There are two acceptable formats. File and Label-Value pair.

File format

{
  "label": "File:",
  "id": "c80e2239-34cb-4c73-91cb-9d6ff53cfd5a",
  "filename": "file.png"
}

The label and filename will be printed in the PDF document. The 'id' is the temporary id provided by the upload endpoint that will attach the file to the claim.

Label-Value pair format

{
  "label": "",
  "value": ""
}

label: string
value: string, number, bool, a single or array of value-pairs/files.

Optional Parameters with additional functionality

External Ref

Strictly for reference. If passed, the external ref will be attached to the Claim and be returned with the Claim Status endpoint. Any string is accepted, but it should be globally unique to avoid claims with duplicate external refs.

{
    "personal": {
        ...,
        "external-ref": {
            "label": "External Reference ID",
            "value": "this-can-be-anything"
        },
    }
}

Date of Birth

If passed, overrides the Date of Birth provided on the policy. This is required when the claimant differs from the primary policy holder.

{
    "personal": {
        ...,
        "dob": {
            "label": "Date of Birth",
            "value": "1994-03-03"
        },
    }
}

Example Request with additional details

Assume we want to also collect the State and City for the incident location.
We simply add those values to the minimum required payload:

{
  "personal": ...,
  "claim": {
    "label": "Claim",
    "value": {
      "incident-date": ...,
      "incident-location": {
        "label": "Where did this happen?",
        "value": {
          "city": {
            "label": "City",
            "value": "Columbus"
          },
          "state": {
            "label": "State",
            "value": "OH"
          },
          "country": ...
        }
      }
    }
  },
  "consent": ...,
}

Any further data will be added to the PDF but otherwise unused by NIS. It must match one of the following structures:
There are two acceptable formats. File and Label-Value pair.
### File format
```json
{
  "label": "File:",
  "id": "c80e2239-34cb-4c73-91cb-9d6ff53cfd5a",
  "filename": "file.png"
}

The label and filename will be printed in the PDF document. The 'id' is the temporary id provided by the upload endpoint that will attach the file to the claim.

Label-Value pair format

{
  "label": "",
  "value": ""
}

label: string
value: string, number, bool, a single or array of value-pairs/files.

Example Request with additional details

Assume we want to also collect the State and City for the incident location.
We simply add those values to the minimum required payload:

{
  "personal": ...,
  "claim": {
    "label": "Claim",
    "value": {
      "incident-date": ...,
      "incident-location": {
        "label": "Where did this happen?",
        "value": {
          "city": {
            "label": "City",
            "value": "Columbus"
          },
          "state": {
            "label": "State",
            "value": "OH"
          },
          "country": ...
        }
      }
    }
  },
  "consent": ...,
}

```

Request Body

{"personal"=>{"label"=>"Personal", "value"=>{"policy-num"=>{"label"=>"Policy Number", "value"=>"RITI-BF1004200069"}, "name"=>{"value"=>{"first"=>{"label"=>"First Name", "value"=>"John"}, "last"=>{"label"=>"Last Name", "value"=>"Doe"}}}, "email"=>{"label"=>"Email", "value"=>"test@example.com"}, "phone-number"=>{"label"=>"Contact number", "value"=>"(555) 555-5555"}, "claim-type"=>{"label"=>"Claim Type", "value"=>"cancellation"}, "coverage-cause"=>{"label"=>"Cause", "value"=>"Injury"}}}, "claim"=>{"label"=>"Claim", "value"=>{"incident-date"=>{"label"=>"When did it happen?", "value"=>"2022-10-15T03:59:59.000Z"}, "incident-location"=>{"label"=>"Where did this happen?", "value"=>{"country"=>{"label"=>"Country", "value"=>"US"}}}}}, "consent"=>{"label"=>"Consent", "value"=>{"signature"=>{"value"=>{"first"=>{"label"=>"First Name", "value"=>"John"}, "last"=>{"label"=>"Last Name", "value"=>"Doe"}}}}}}

RESPONSES

status: OK

{"task_queued":true}