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

# Get Claim List

Get a list of claims based on some filters. This will return claims that the partner has created or has access to.

# 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": {
      "get": {
        "summary": "Get Claim List",
        "description": "Get a list of claims based on some filters. This will return claims that the partner has created or has access to.",
        "tags": [
          "API Specification"
        ],
        "parameters": [
          {
            "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"
          },
          {
            "in": "query",
            "name": "refNo",
            "schema": {
              "type": "string"
            },
            "description": "Reference number from partner specified when creating a claim. Accepts multiple reference numbers, e.g. ?refNo=value1&refNo=value2.",
            "example": "9f61de6a-c253-4378-b7f1-7ed680405376"
          },
          {
            "in": "query",
            "name": "trxId",
            "schema": {
              "type": "string"
            },
            "description": "Application transaction ID. Accepts multiple transaction IDs, e.g. ?trxId=value1&trxId=value2.",
            "example": "partner-733a26be-b0d3-499c-b65b-65240c8364a6"
          },
          {
            "in": "query",
            "name": "claimId",
            "schema": {
              "type": "string"
            },
            "description": "Claim ID. Accepts multiple claim IDs, e.g. ?claimId=value1&claimId=value2.",
            "example": "CL-FYVXCPC"
          },
          {
            "in": "query",
            "name": "productId",
            "schema": {
              "type": "string"
            },
            "description": "Insurance product ID. Accepts multiple product IDs, e.g. ?productId=value1&productId=value2.",
            "example": "product-1"
          },
          {
            "in": "query",
            "name": "policyNumber",
            "schema": {
              "type": "string"
            },
            "description": "Insurance policy number. Accepts multiple policy numbers, e.g. ?policyNumber=value1&policyNumber=value2.",
            "example": "policy-number-1"
          },
          {
            "in": "query",
            "name": "claimType",
            "schema": {
              "type": "string"
            },
            "description": "Claim type.",
            "example": "Kerusakan total"
          },
          {
            "in": "query",
            "name": "status",
            "schema": {
              "type": "string"
            },
            "description": "Claim status. Refer to [Claim Status](https://docs.cermatiprotect.com/reference/claim-status) section. Accepts multiple statuses, e.g. ?status=value1&status=value2.",
            "example": "APPROVED"
          },
          {
            "in": "query",
            "name": "createdDateAfter",
            "schema": {
              "type": "string"
            },
            "description": "Earliest creation date (operator >=). Format: YYYY-MM-DD.",
            "example": "2022-05-01"
          },
          {
            "in": "query",
            "name": "createdDateBefore",
            "schema": {
              "type": "string"
            },
            "description": "Latest creation date (operator <=). Format: YYYY-MM-DD.",
            "example": "2022-05-31"
          },
          {
            "in": "query",
            "name": "size",
            "schema": {
              "type": "integer"
            },
            "description": "Number indicating the limit of items returned from this search. Default: 20 (maximum is 50).",
            "example": 20
          },
          {
            "in": "query",
            "name": "page",
            "schema": {
              "type": "integer"
            },
            "description": "Number indicating the page number. Default: 1.",
            "example": 1
          },
          {
            "in": "query",
            "name": "sort",
            "schema": {
              "type": "string"
            },
            "description": "Field name to be sorted. Default: createdAt.",
            "example": "createdAt"
          },
          {
            "in": "query",
            "name": "order",
            "schema": {
              "type": "string",
              "enum": [
                "ASC",
                "DESC"
              ]
            },
            "description": "Sort direction. Options: ASC (ascending), DESC (descending). Default: DESC.",
            "example": "ASC"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/GetClaimList"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    },
    "responses": {
      "GetClaimList": {
        "description": "",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "array",
                  "description": "List of claims.",
                  "items": {
                    "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."
                      },
                      "policyNumber": {
                        "type": "string",
                        "description": "Insurance policy number."
                      },
                      "status": {
                        "type": "string",
                        "description": "Claim status. Refer to [Claim Status](https://docs.cermatiprotect.com/reference/claim-status) section."
                      },
                      "link": {
                        "type": "string",
                        "format": "uri",
                        "description": "Link to retrieve the resource: **{BASE_URL}/claims/{claimId}**, e.g. https://api.cermatiprotect.com/insurance/v1/claims/CL-FYVXCPC."
                      },
                      "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",
                      "policyNumber",
                      "status",
                      "link",
                      "createdAt",
                      "updatedAt",
                      "expiredAt"
                    ]
                  }
                }
              },
              "required": [
                "data"
              ]
            },
            "examples": {
              "Success": {
                "$ref": "#/components/examples/GetClaimListResponse"
              }
            }
          }
        }
      }
    },
    "examples": {
      "GetClaimListResponse": {
        "value": {
          "data": [
            {
              "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",
              "policyNumber": "CQ1ENMH7",
              "status": "APPROVED",
              "link": "https://api.cermatiprotect.com/insurance/v1/claims/CL-FYVXCPC",
              "createdAt": "2022-04-26T18:53:09.000+07:00",
              "updatedAt": "2022-05-03T14:20:00.000+07:00",
              "expiredAt": "2022-05-26T18:53:09.000+07:00",
              "submittedAt": "2022-04-28T20:02:20.000+07:00",
              "cancelledAt": null
            },
            {
              "refNo": "71b9732a-eeaf-4b60-91a9-bca9c64a04ce",
              "trxId": "partner-b2221701-dce4-47e5-b734-b14385f58711",
              "claimId": "CL-SGQPJ7GW",
              "productId": "product-1",
              "claimType": "Kerusakan total",
              "claimTypeLabel": "Kerusakan total",
              "insuredName": "Jane Doe",
              "policyNumber": "CQ1ENMH8",
              "status": "REJECTED",
              "link": "https://api.cermatiprotect.com/insurance/v1/claims/CL-SGQPJ7GW",
              "createdAt": "2022-04-20T13:00:09.000+07:00",
              "updatedAt": "2022-05-14T18:22:00.000+07:00",
              "expiredAt": "2022-05-20T13:00:09.000+07:00",
              "submittedAt": "2022-04-22T10:45:21.000+07:00",
              "cancelledAt": null
            }
          ]
        }
      }
    }
  },
  "security": [
    {
      "basicAuth": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  }
}
```