Intake

/claim/intake/retrieveDocRequirements

Use this endpoint to retrieve the document requirements for a given claim so it can be displayed and acted upon by the intended user interface.

Prerequisite API call:

/claim/intake/addQuestionnaire

post/claim/intake/retrieveDocRequirements

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/intake/retrieveDocRequirements
Auth
none declared

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 document requirements request

rtokenstring nullable

A system-generated ID used for tracking

StatusCodeinteger nullable

The HTTP response status code

Example response

{
  "DocumentRequirementList": [
    {
      "TemplateDocumentStream": "JVBERi0xLjQKJcfl9OXwCjEgMCBvYmoKPDwKL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAxMjU4Cj4+CnN0cmVhbQp42s1YW3PTOBR+r+",
      "Identifier": "StatementOfDispute",
      "IsRequired": true,
      "Label": "Statement of Dispute",
      "ValidAttachmentCategoryList": [
        {
          "Key": "SupportingDocumentation",
          "Value": "Supporting Documentation"
        }
      ]
    }
  ],
  "TransactionDetails": {
    "SelectedPostedTransactionList": [
      {
        "AmountInfo": {
          "ISOCodeAlpha": "USD",
          "ISOCurrencyName": "US Dollar"
        },
        "AuthorizationStatus": "Posted",
        "DebitCredit": "Debit",
        "Description": "7-ELEVEN 22177 (CHIP)",
        "PostingDateTime": "20230201T225915.773 GMT",
        "TransactionDateTime": "20230201T225915.773 GM",
        "TransactionType": "CardPinless"
      }
    ],
    "SelectedPendingTransactionList": [
      {
        "AmountInfo": {
          "ISOCodeAlpha": "USD",
          "ISOCurrencyName": "US Dollar"
        },
        "AuthorizationStatus": "Posted",
        "DebitCredit": "Debit",
        "Description": "7-ELEVEN 22177 (CHIP)",
        "PostingDateTime": "20230201T225915.773 GMT",
        "TransactionDateTime": "20230201T225915.773 GM",
        "TransactionType": "CardPinless"
      }
    ],
    "SelectedRecurringTransactionList": [
      {
        "AmountInfo": {
          "ISOCodeAlpha": "USD",
          "ISOCurrencyName": "US Dollar"
        },
        "AuthorizationStatus": "Posted",
        "DebitCredit": "Debit",
        "Description": "7-ELEVEN 22177 (CHIP)",
        "PostingDateTime": "20230201T225915.773 GMT",
        "TransactionDateTime": "20230201T225915.773 GM",
        "TransactionType": "CardPinless"
      }
    ],
    "DeflectedTransactionList": [
      {
        "AmountInfo": {
          "ISOCodeAlpha": "USD",
          "ISOCurrencyName": "US Dollar"
        },
        "AuthorizationStatus": "Posted",
        "DebitCredit": "Debit",
        "Description": "7-ELEVEN 22177 (CHIP)",
        "PostingDateTime": "20230201T225915.773 GMT",
        "TransactionDateTime": "20230201T225915.773 GM",
        "TransactionType": "CardPinless"
      }
    ]
  },
  "StatusList": [
    {
      "Type": "Success",
      "Message": "Success",
      "Code": "200"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.