Submitting a draft claim

You can use the POST /claim/v1/claims/{claimId}/submit endpoint to submit a draft claim. If the call executes successfully, then:

  • The draft claim becomes an open claim.
  • The claim is assigned an open claim number.
  • Automated claim setup is executed on the claim. This includes executing business rules to:
    • Segment the claim
    • Assign the claim
    • Create and assign activities for the claim

Minimum information to submit a draft claim

From an internal standpoint, the minimum amount of information to submit a draft claim is the same as to create a draft claim:

  • Policy number
  • Loss date

However, ClaimCenter also includes a series of validation rules. In the base configuration, the claim, the policy, and any incidents must reach or pass the New Loss Completion validation level. Exposures must reach or pass the Load Save validation level. The /submit endpoint will not succeed if any of these objects do not reach the required validation level. (For more information on how the required levels for exposures can be configured, see Claim validation at FNOL.

For example, in the base configuration, in addition to policy number and loss date, you must also specify a reporter. The requirement to include a reporter is implemented by the "CLV04000 - ClaimContact Role Configuration" validation rule, which throws an error at the NewLossCompletion level if the reporter is null. For an example of a payload that creates a minimum base-configuration-submittable claim, see the Sample payload addendum.

Draft claims that trigger errors

When you submit a draft claim, ClaimCenter generates an open claim number for the claim. If the submit action generates no errors, the open claim number is assigned to the claim in place of the draft claim number.

However, it is possible for the submit action to throw either a validation error (because it is missing information required for the LoadSave and NewLossCompletion levels) or an assignment error (because the assignment rules cannot successfully assign the claim to a group and user). If either of these occurs, the claim remains in a draft state and retains its draft claim number. The generated open claim number is discarded. The system APIs also return an error message stating that the claim could not be submitted. This error message references the claim by its draft number.

Minimum criteria for submitting a claim with an unverified policy

You can create a draft claim with only a policy number and loss date. However, in the base configuration, a claim must also have a reporter before it can be submitted.

The following composite request creates an unverified policy, a claim, and a ClaimContact who is then listed as the reporter. It then submits the claim. Note that this requires five sub-requests:

  1. Create the unverified policy.
  2. Create the claim.
  3. Create the ClaimContact.
  4. Modify the claim to assign the role of reporter to the ClaimContact.
  5. Submit the claim.

In the base configuration, this is the minimum amount of information needed to create and submit a claim with an unverified policy.

Command

POST /composite/v1/composite

Request body

{
  "requests": [
    {
      "method": "post",
      "uri": "/claim/v1/unverified-policies",
      "body": {
        "data": {
          "attributes": {
            "policyNumber": "unverified-minimum-submittable",
            "policyType": {
              "code": "PersonalAuto"
            }
          }
        }
      }
    },
    {
      "method": "post",
      "uri": "/claim/v1/claims",
      "body": {
        "data": {
          "attributes": {
            "lossDate": "2021-03-04T07:00:00.000Z",
            "policyNumber": "unverified-minimum-submittable"
            }            
          }
        },
      "vars": [
        {
          "name": "claimId",
          "path": "$.data.attributes.id"
        }
      ]
    },
    {
      "method": "post",
      "uri": "/claim/v1/claims/${claimId}/contacts",   
      "body": {       
        "data": {
          "attributes": {
            "contactSubtype": "Person",
            "firstName": "Ray",
            "lastName": "Newton"
          }
        }
      },
      "vars": [
        {
          "name": "contactId",
          "path": "$.data.attributes.id"
        }
      ]
    },
    {
      "method": "patch",
      "uri": "/claim/v1/claims/${claimId}",
      "body": {
        "data": {
          "attributes": {
            "reporter": {
              "id": "${contactId}"
            }
          }
        }
      }
    },
    {
      "method": "post",
      "uri": "/claim/v1/claims/${claimId}/submit"
    }
  ]
}

Tutorial: POSTing a typical draft claim for personal auto

This tutorial assumes you have completed the following prerequisite tutorials:

In this tutorial, you will create a draft claim for a personal auto policy using a typical amount of information needed. This claim is for Ray Newton, who has a personal auto policy that covers a Toyota Prius. On March 1, Ray hit a Honda Civic driven by Robert Farley. Both vehicles suffered minor damage.

  1. Start ClaimCenter.
  2. In Postman, start a new request by clicking the + to the right of the Launchpad tab.
    1. On the Authorization tab, select Basic Auth using user su and password gw.
  3. Enter the following call, but do not click Send yet:
    • POST http://localhost:8080/cc/rest/claim/v1/claims
  4. Specify the request payload.
    1. In the first row of tabs (the one that starts with Params), click Body.
    2. In the row of radio buttons, select raw.
    3. At the end of the row of radio buttons, change the drop-down list value from Text to JSON.
    4. Paste the text in the Sample draft claim payload addendum into the text field underneath the radio buttons. If necessary, modify the payload's lossDate to ensure the loss occurred while the policy from the previous tutorial is in force, but not in the future.
  5. Click Send.
  6. The response payload includes the claim's ID and claim number. Copy both of these values to a separate location, as they are needed for later tutorials.

Checking your work

  1. View the new draft claim in ClaimCenter.
    1. In the response payload, note the claim number of the new draft claim. (It is on or near line 8, and it likely starts with "999-99".)
    2. Log on to ClaimCenter as su.
    3. Click the Claim tab, enter the claim number in the Claim # menu item, and press Enter.

ClaimCenter navigates to the draft claim. Because the claim has minimal information only, ClaimCenter navigates to the Basic Info step of the New Claim Wizard. The policy number and loss date are listed in the Info Bar. (Policy number is labeled Pol, and loss date is labeled DoL.) The policy number and loss date match the data in the POST /claims request payload.

Note that, in the base configuration, the New Claim Wizard does not display claim numbers while the claim is in a draft state.