v1

latestOpenAPI 3.0.32026-07-2621102.1 MB

Status

/claim/retrieve

Use this endpoint to retrieve claim details and status

post/claim/retrieve

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"

claimIdstring required

Unique claim ID

statusRolestring required

Status role of the current user

Example request

{
  "providerId": 9999,
  "transactionId": "984513-395483653-4483483478",
  "claimId": "2501240026C",
  "statusRole": "Customer"
}

Response

Successful status retrieve request

ClaimTypestring

ClaimReasonstring

ClaimReasonTypestring

TotalClaimAmountnumber

IsRegE10Satisfiedboolean

Whether the Reg E 10 Business Day provisional credit obligation has been satisfied.

RegE10string Date-Time

The deadline by which provisional credit must be granted and the provisional credit letter sent — 10 business days from the contact date (for ATM/debit POS and non-US ATM disputes).

RegE10Thresholdstring Date-Time

The approaching/warning date for the Reg E 10 milestone, used to trigger early action before the RegE10 deadline.

IsRegESatisfiedboolean

Whether the final Reg E resolution deadline has been satisfied.

RegEDeadlinestring Date-Time

The final Reg E regulatory deadline by which the claim must be resolved (write-off executed and resolution letter sent). 90 days for POS/non-US ATM disputes; 45 days for US ATM and ACH disputes.

RegEThresholdstring Date-Time

The approaching/warning date for the final Reg E deadline (RegEDeadline), used to trigger action before the deadline is breached.

IsRegZ30Satisfiedboolean

Whether the Reg Z 30-day acknowledgement obligation has been satisfied.

RegZ30string Date-Time

The deadline by which an acknowledgement letter must be sent to the cardholder — 30 days from the contact date.

RegZ30Thresholdstring Date-Time

The approaching/warning date for the Reg Z 30 milestone.

IsRegZPCSatisfiedboolean

Whether the Reg Z Withholding Protection provisional credit obligation has been satisfied.

RegZPCstring Date-Time

The Reg Z Withholding Protection date — the deadline by which provisional credit must be issued to prevent collection on the disputed amount (primarily relevant for cardholders enrolled in autopayment). Set to the earlier of the next autopayment date or statement cycle date, with a minimum of contact date + 3 business days.

RegZPCThresholdstring Date-Time

The approaching/warning date for the Reg Z PC provisional credit milestone.

IsRegZ90Satisfiedboolean

Whether the Reg Z 90-day resolution obligation has been satisfied.

RegZ90string Date-Time

The final Reg Z deadline by which write-off must be executed and a resolution letter sent. Equals the 2nd statement cycle date following the contact date, capped at 90 days. Defaults to 60 days if cycle date is unavailable or the calculated date falls below 60 days.

RegZ90Thresholdstring Date-Time

The approaching/warning date for the Reg Z 90 milestone.

ExternalCaseIdstring

Optional ID representing claim identifier external to this dispute system (client internal identifier)

CustomerContactDatestring Date-Time

Date customer contacted institution about dispute

CreateNamestring

userId of the user who created the claim

AccountTypestring

ClaimStatusstring

AccountHolderstring

HasOutstandingTasksboolean

Does the claim have oustanding workable tasks for interaction api

HeaderDisplaystring

Text for display

rtokenstring nullable

A system-generated ID used for tracking

StatusCodeinteger nullable

The HTTP response status code

Example response

{
  "CustomerContactDate": "2024-08-05T16:29:45.350Z",
  "CreateName": "dispute_api@disputeme.info",
  "AccountType": "CreditCard",
  "ClaimStatus": "Open-Analyze",
  "AccountHolder": "SoFi Tech Solutions User"
}