Create a Claim via API

Prepare for setup

After installing the Create Claim via API add-on module, you can use it to create a claim directly in the Connected Claims Base application. This provides definitions for the Create Claim via API available after installing this add-on module in the same environment as your Connected Claims Base application.

The current version of the Create Claim API add-on module is version 1.1. All documentation on this page is pertinent to this version.

System prerequisites

This section details the minimum requirements your system must meet to run the Create Claim API add-on module:

• Appian platform running version 26.6 or greater.
• An Appian Cloud environment with the advanced or premium platform tiers.
• A supported version of MariaDB as a business data source.
  • Note: Instructions below are for MariaDB databases. For use with other databases, the SQL script will need to be modified.
• A supported web browser.
• Imported Connected Claims Management Base Application application version 2.0 and higher, which includes the following application containers:
  • Connected Claims Management Base (CCM)
  • CCM Studio Generated Objects
• Imported Create Claim API add-on module application containers, including:
  • CCM Add-On: Create Claim API (CCM_API_CC)

Required incorporation

The following steps are the bare minimum incorporation steps required to utilize the full functionality of the Create Claim API. Implementers are free to customize the security, display names, and other aspects of the application to best suit their needs.

Add the service account user to the API access group

To add the service account to the API access group:

1. In Designer, go to the CCM Add-On: Create Claim API application.
2. Search for the CCM_API_CC API Access Create Claim group.
3. Add the service account that you created in Create a service account of the installation guide to the group.

Endpoint

This section describes the API endpoint configuration and versioning for the Create Claim API.

The Create Claim API has a default endpoint of ccm-claim-create. You can append the API version to the end of the endpoint. For example, ccm-claim-create/v1 calls version 1 of the Create Claim API. If you do not provide a version path, the API uses v1.

Expected request structure

This section outlines the required format and structure for API requests to successfully create claims.

Headers

Clients are expected to send a Content-Type header as application/json. This is standard behavior for Appian API objects.

Query parameters

There are no expected query parameters that should be sent in a request to the Create Claim API.

Body

The expected structure of a request body can be seen below:

Variable Name	Datatype	Required
claimType	code	Conditional
policyNumber	text	Conditional
title	text	Required
lossAddressCountry	code	Required
lossAddressLine1	text	Required
lossAddressLine2	text	Optional
lossAddressCity	text	Required
lossAddressStateProv	code	Conditional
lossAddressPostalCode	text	Required
lossDate	date	Required
lossAmountCurrency	code	Required
lossAmount	decimal	Required
lossDescription	text	Required
relatedParties	list of dictionary	Required

relatedParties dictionary

Within each relatedParties dictionary, the following structure is expected:

Variable Name	Datatype	Required
entityType	code	Required
name	text	Required
roleTypes	list of code	Required
phoneNumber	text	Conditional
email	text	Conditional

Code fields

The fields listed above with a code datatype indicate that requests are expected to have a specific value from a predefined list provided for these fields. In the backend, these fields correspond to a specific list of reference data. Failure to provide a valid value for any one of these fields will result in a 400 error response.

A list of codes valid for a particular field can be found in the API_CODE column of the corresponding reference data table. As additional pieces of reference data are added, values in this column can be updated so that the new piece of reference data can be accepted by this API or other APIs across the application.

For front-end editable reference data, like Claim Type, the value of the API_CODE column is not populated on data write when users take corresponding actions to create or edit that piece of data. This means that in order to enable these new records to be referenced in the API, a developer must execute a database script that populates the value in the API_CODE column.

Possible responses

This section details the various response codes and error messages that the API may return based on different request scenarios.

The following response codes can be sent back to the caller of the Create Claim API:

• Response Code 200: This response code indicates a successful request and creation of a Claim in Appian. The provided response body will contain the Claim ID of the newly-created claim.

• Response Code 400: This response indicates a bad request was sent by the caller. Claims will not be made from requests that return a 400 error response. In the response body, additional information will be provided as to why the request was bad. Possible errorCodes contained in the response body include:

  • MISSING_REQUIRED_FIELD
    • A field that was required in the request body was not present. The field that was missing will be provided.
  • INVALID_CODE
    • A field that expects a code datatype did not have a valid value. The field that had an invalid value will be provided.
  • DATA_INTEGRITY_VIOLATION
    • Additional validations that take place on the request body were violated. This can include a range of possibilities and mimic any additional validations present in manual creation of a Claim. Possible reasons include sending both claimType and policyNumber, sending a policyNumber that does not correspond to a policy in the system, or sending a stateProv code that does not correspond to its sent country code.
  • DATABASE_LENGTH_VIOLATION
    • A field provided in the request breached its maximum length allowed in the database. The field or fields that were too long will be provided.

• Response Code 404: This response code is an Appian default and indicates there was a problem authenticating.

• Response Code 500: This response code is an Appian default and indicates there was a backend expression or process error.

Use the Create Claim via API module after setup

After you set up the Create Claim via API module, you can programmatically create claims in Connected Claims through REST API calls, enabling integration with external systems and automated claim creation workflows.

Feedback