---
title: "/claim/list"
method: POST
path: "/claim/list"
tags: ["Claim"]
---

# /claim/list

`POST /claim/list`

## Request

- Base URL: `{corename}.gft-dispute-api.{env}.gpsrv.com/gft-dispute-api/1.0`
- URL: `{corename}.gft-dispute-api.{env}.gpsrv.com/gft-dispute-api/1.0/claim/list`
- Auth: none declared

Use this endpoint to get a list of claims for the provided search parameters 

You must pass only one of these fields: `customerId`, `accountNumber`, `claimId`.

## Request body

- object
  - `providerId` integer, required: Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: `9999`
  - `transactionId` string, required: Supply a globally unique ID to identify this endpoint request ("transaction"). Pattern: Max 60 characters Example: `"984513-395483653-4483483478"`
  - `daysToLookBack` number: Days prior to search for claims. REQUIRED
  - `customerId` string: Customer ID to search for claims for. Pass the same value as `accountNumber`. Exactly one of `customerId`, `accountNumber`, or `claimId` is required Pattern: `P{prog_id}|{prn}` Example: `P123|123456789012`
  - `accountNumber` string: Account number to search for claims for. Exactly one of `customerId`, `accountNumber`, or `claimId` is required. Pattern: `P{prog_id}|{prn}` Example: `P123|123456789012`
  - `claimId` string: Specific Claim ID to search for Exactly one of `customerId`, `accountNumber`, or `claimId` is **required**

## Response `200`

Successful claim list request

- object
  - `claimListResponse` object[]
    - `accountHolder` string: Account Holder
    - `requiredDocumentCount` number: Number of document required on this claim
    - `customerContactDate` string, Date-Time: Customer Contact Date<br><br> Format:yyyyMMdd
    - `claimId` string: Unique claim ID
    - `accountNumber` string: Account Number
    - `claimStatus` string: Status of the Claim, see <a href="ref:api-reference-status-values-3" target="_blank">Status Values</a>
    - `createName` string: Who created the claim
    - `accountType` string: Type of account
    - `customerId` string: Customer ID
    - `externalCaseId` string: Optional ID representing claim identifier external to this dispute system (client internal identifier)
    - `isClaimSubmitted` boolean: If the claim has been submitted or not
    - `totalClaimAmount` number: The sum of all disputed transaction amounts
  - `StatusList` object[]
    - `Type` 'Error' | 'Success': Status of the request
    - `Message` string: Message about the status
    - `Code` string: Numeric code for the status
  - `rtoken` string, nullable: A system-generated ID used for tracking
  - `StatusCode` integer, nullable: The HTTP response status code

## Other responses

- `400`: Error claim list request
- `500`: Error claim list request

---

[API](https://skmtc.dev/galileo-ft/apis/dispute-api-3-0.md) - [All operations](https://skmtc.dev/galileo-ft/apis/dispute-api-3-0/llms.txt) - [OpenAPI document](https://skmtc.dev/galileo-ft/apis/dispute-api-3-0/revisions/cf13cabe7c95?raw)