Sign in

v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
Claim

/claim/list

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.

post/claim/list

Request body

providerIdinteger required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Pattern: Max 60 characters Example: "984513-395483653-4483483478"

daysToLookBacknumber

Days prior to search for claims. REQUIRED

customerIdstring

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

accountNumberstring

Account number to search for claims for. Exactly one of customerId, accountNumber, or claimId is required. Pattern: P{prog_id}|{prn} Example: P123|123456789012

claimIdstring

Specific Claim ID to search for

Exactly one of customerId, accountNumber, or claimId is required

Example request

{
  "providerId": 9999,
  "transactionId": "984513-395483653-4483483478",
  "daysToLookBack": 30,
  "customerId": "P123|123456789012",
  "accountNumber": "P123|123456789012",
  "claimId": "2503040008C"
}

Response

Successful claim list request

rtokenstring nullable

A system-generated ID used for tracking

StatusCodeinteger nullable

The HTTP response status code