Sign in

v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
Intake

/claim/intake/retrieveQuestionnaire

This API retrieves the questionnaire for a given claim so it can be displayed and acted upon by the intended user interface.

Prerequisite API call:

  • /claim/intake/addTransactions

📘 Note

This endpoint may return different data depending on the value of profile-type. See <a href="ref:api-reference-profile-type-differences" target="_blank">Profile Type Differences</a> for details.

post/claim/intake/retrieveQuestionnaire

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

Example request

{
  "providerId": 9999,
  "transactionId": "984513-395483653-4483483478",
  "ClaimId": "2108160022C"
}

Response

Successful retrieve questionnaire request

rtokenstring nullable

A system-generated ID used for tracking

StatusCodeinteger nullable

The HTTP response status code

Example response

{
  "Questionnaire": {
    "QuestionList": [
      {
        "Identifier": "ClaimReason",
        "DisplayText": "Which of the following best describes the reason for your dispute?",
        "DataType": "String",
        "Type": "RadioButtons",
        "Format": "RadioButtons",
        "IsOptional": true,
        "AnswerList": [
          {
            "Identifier": "MerchantDuplicate",
            "DisplayText": "I was charged more than once."
          }
        ],
        "SelectedAnswer": "Yes",
        "APIDocumentationList": [
          {
            "ImplementationNotes": "Get list of similar transactions within search criteria",
            "Endpoint": "/claim/intake/retrieveSimilarTransactions",
            "Method": "post"
          }
        ]
      }
    ]
  },
  "PostQuestionnaire": {
    "QuestionList": [
      {
        "Identifier": "ClaimReason",
        "DisplayText": "Which of the following best describes the reason for your dispute?",
        "DataType": "String",
        "Type": "RadioButtons",
        "Format": "RadioButtons",
        "IsOptional": true,
        "AnswerList": [
          {
            "Identifier": "MerchantDuplicate",
            "DisplayText": "I was charged more than once."
          }
        ],
        "SelectedAnswer": "Yes",
        "APIDocumentationList": [
          {
            "ImplementationNotes": "Get list of similar transactions within search criteria",
            "Endpoint": "/claim/intake/retrieveSimilarTransactions",
            "Method": "post"
          }
        ]
      }
    ]
  },
  "TransactionDetails": {
    "SelectedPostedTransactionList": [
      {
        "AmountInfo": {
          "ISOCodeAlpha": "USD",
          "ISOCurrencyName": "US Dollar"
        }
      }
    ],
    "SelectedPendingTransactionList": [
      {
        "AmountInfo": {
          "ISOCodeAlpha": "USD",
          "ISOCurrencyName": "US Dollar"
        }
      }
    ],
    "SelectedRecurringTransactionList": [
      {
        "AmountInfo": {
          "ISOCodeAlpha": "USD",
          "ISOCurrencyName": "US Dollar"
        }
      }
    ],
    "DeflectedTransactionList": [
      {
        "AmountInfo": {
          "ISOCodeAlpha": "USD",
          "ISOCurrencyName": "US Dollar"
        }
      }
    ]
  }
}