---
updatedAt: 2026-07-27T10:30:13.000Z
agentTools:
  projectIndex: https://docs.cermatiprotect.com/llms.txt
---

# Cancel Claim

Cancel a claim. Only claims with INITIATED status can be cancelled. This will change the status to CANCELLED.

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "title": "Cermati Protect Claim API",
    "version": "1.1.0",
    "description": "This is the documentation of Cermati Protect Claim API",
    "termsOfService": "https://www.cermatiprotect.com/pages/terms-and-conditions",
    "contact": {
      "email": "dev@cermatiprotect.com"
    },
    "x-logo": {
      "url": "https://static.cermatiprotect.com/static/dist/images/logo/cermati-protect-white.png"
    }
  },
  "tags": [
    {
      "name": "API Specification",
      "description": "The specification of Cermati Protect Claim API"
    }
  ],
  "servers": [
    {
      "url": "https://api-staging.cermatiprotect.com/insurance/v1"
    },
    {
      "url": "https://api.cermatiprotect.com/insurance/v1"
    }
  ],
  "paths": {
    "/claims/{claimId}/cancel": {
      "post": {
        "summary": "Cancel Claim",
        "description": "Cancel a claim. Only claims with INITIATED status can be cancelled. This will change the status to CANCELLED.",
        "tags": [
          "API Specification"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "claimId",
            "schema": {
              "type": "string"
            },
            "required": true,
            "description": "Claim ID.",
            "example": "CL-FYVXCPC"
          },
          {
            "in": "header",
            "name": "X-Locale",
            "schema": {
              "type": "string",
              "enum": [
                "id",
                "en"
              ]
            },
            "description": "Preferred language for headings, labels, placeholders, help texts, and form validation messages. Default: id.\n\nNote: en is currently only available for select product IDs.",
            "example": "id"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/CancelClaim"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    },
    "responses": {
      "CancelClaim": {
        "description": "",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Claim"
            },
            "examples": {
              "Success": {
                "$ref": "#/components/examples/CancelClaimResponse"
              }
            }
          }
        }
      }
    },
    "schemas": {
      "Claim": {
        "type": "object",
        "properties": {
          "refNo": {
            "type": "string",
            "description": "Unique identifier from the partner."
          },
          "trxId": {
            "type": "string",
            "description": "Application transaction ID."
          },
          "claimId": {
            "type": "string",
            "description": "Claim ID."
          },
          "productId": {
            "type": "string",
            "description": "Product ID of the insurance."
          },
          "claimType": {
            "type": "string",
            "description": "Claim type."
          },
          "claimTypeLabel": {
            "type": "string",
            "description": "Claim type translation in locale."
          },
          "insuredName": {
            "type": "string",
            "description": "Name of the customer covered by the insurance."
          },
          "status": {
            "type": "string",
            "description": "Claim status. Refer to [Claim Status](https://docs.cermatiprotect.com/reference/claim-status) section."
          },
          "form": {
            "type": "array",
            "description": "Claim form divided by section. Claim form is a form that the customer has to fill out before submitting a claim.",
            "items": {
              "type": "object",
              "properties": {
                "heading": {
                  "type": "string",
                  "description": "Section heading."
                },
                "fields": {
                  "type": "array",
                  "description": "List of fields in the section.",
                  "items": {
                    "$ref": "#/components/schemas/FormFieldWithValue"
                  }
                }
              },
              "required": [
                "heading",
                "fields"
              ]
            }
          },
          "reason": {
            "type": "string",
            "description": "Reason for the current status."
          },
          "approvedClaimAmount": {
            "type": "number",
            "description": "Claim amount approved by the Insurer in IDR."
          },
          "reimbursedClaimAmount": {
            "type": "number",
            "description": "Claim amount sent to the customer in IDR."
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "Creation time of the claim (ISO 8601 format)."
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Last updated time of the claim (ISO 8601 format)."
          },
          "expiredAt": {
            "type": "string",
            "format": "date-time",
            "description": "Expiration time of the claim (ISO 8601 format).\n\nIf the claim is not submitted by the expiration time, the status will be automatically updated to EXPIRED."
          },
          "submittedAt": {
            "type": "string",
            "format": "date-time",
            "description": "Submission time of the claim (ISO 8601 format)."
          },
          "cancelledAt": {
            "type": "string",
            "format": "date-time",
            "description": "Cancellation time of the claim (ISO 8601 format)."
          }
        },
        "required": [
          "refNo",
          "trxId",
          "claimId",
          "productId",
          "claimType",
          "claimTypeLabel",
          "insuredName",
          "status",
          "form",
          "createdAt",
          "updatedAt",
          "expiredAt"
        ]
      },
      "FormFieldType": {
        "type": "string",
        "description": "Field type. List of field types:\n\n| Type | Description |\n|---|---|\n| text | Inline text field |\n| textarea | Textarea field. |\n| number | Number field. |\n| select | Dropdown field. |\n| date | Date field. Format: YYYY-MM-DD. |\n| time | Time field. Format: HH:mm. |\n| email | Email field. |\n| phone | Phone number field. |\n| file | Single file upload field. Max size is 30 MB. Allowed file types: .jpeg, .jpg, .png, .mp4, .mov, .pdf. |\n| checkbox | Checkbox field (boolean). |"
      },
      "FormOption": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "description": "Label to be displayed to the customer."
          },
          "value": {
            "type": "string",
            "description": "Value to be submitted with the form."
          }
        },
        "required": [
          "label",
          "value"
        ]
      },
      "FormFieldWithValue": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Field ID."
          },
          "label": {
            "type": "string",
            "description": "Name of the field."
          },
          "placeholder": {
            "type": "string",
            "description": "Hint or suggestion of what kind of input will be valid."
          },
          "helpText": {
            "type": "string",
            "description": "Text describing the field usage."
          },
          "type": {
            "$ref": "#/components/schemas/FormFieldType"
          },
          "options": {
            "type": "array",
            "description": "List of options the customer can select from. Required if type is \"select\".",
            "items": {
              "$ref": "#/components/schemas/FormOption"
            }
          },
          "required": {
            "type": "boolean",
            "description": "Flag indicating whether the field is mandatory."
          },
          "value": {
            "type": "string",
            "description": "Value that the customer has inputted.\n\nIf the type is \"file\", the value will be the file's download URL. The URL is dynamically generated on each request and will expire in 24 hours."
          }
        },
        "required": [
          "id",
          "label",
          "type",
          "required"
        ]
      }
    },
    "examples": {
      "CancelClaimResponse": {
        "value": {
          "refNo": "9f61de6a-c253-4378-b7f1-7ed680405376",
          "trxId": "partner-733a26be-b0d3-499c-b65b-65240c8364a6",
          "claimId": "CL-FYVXCPC",
          "productId": "product-1",
          "claimType": "Kehilangan",
          "claimTypeLabel": "Kehilangan",
          "insuredName": "John Doe",
          "status": "CANCELLED",
          "form": [
            {
              "heading": "Informasi Barang",
              "fields": [
                {
                  "id": "item-name",
                  "label": "Nama Barang",
                  "placeholder": "iPhone 13 Pro",
                  "helpText": null,
                  "type": "text",
                  "options": null,
                  "required": true,
                  "value": "iPhone 13 Pro Max"
                },
                {
                  "id": "item-condition",
                  "label": "Kondisi Barang",
                  "placeholder": null,
                  "helpText": null,
                  "type": "select",
                  "options": [
                    {
                      "label": "Baru",
                      "value": "Baru"
                    },
                    {
                      "label": "Bekas",
                      "value": "Bekas"
                    }
                  ],
                  "required": true,
                  "value": "Baru"
                }
              ]
            },
            {
              "heading": "Dokumen Pendukung",
              "fields": [
                {
                  "id": "invoice",
                  "label": "Faktur Pembelian",
                  "placeholder": null,
                  "helpText": "Bukti transaksi yang diterbitkan oleh penjual",
                  "type": "file",
                  "options": null,
                  "required": true,
                  "value": "https://example.com/path/to/image.png"
                }
              ]
            }
          ],
          "reason": null,
          "approvedClaimAmount": null,
          "reimbursedClaimAmount": null,
          "createdAt": "2022-04-26T18:53:09.000+07:00",
          "updatedAt": "2022-05-27T06:10:30.000+07:00",
          "expiredAt": "2022-05-26T18:53:09.000+07:00",
          "submittedAt": null,
          "cancelledAt": "2022-05-27T06:10:30.000+07:00"
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  }
}
```