---
title: "/claim/intake/retrieveDocRequirements"
method: POST
path: "/claim/intake/retrieveDocRequirements"
tags: ["Intake"]
---

# /claim/intake/retrieveDocRequirements

`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

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`

## 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"`
  - `ClaimId` string, required: Unique claim ID

## Response `200`

Successful retrieve document requirements request

- object
  - `DocumentRequirementList` object[]: List of document requirements that must be added to the claim.
    - `TemplateDocumentStream` string: Byte stream of the template form pdf
    - `IsSatisified` boolean: Has this document requirement been satisfied?
    - `Identifier` string: Document requirement identifier
    - `IsRequired` boolean: Is this document required?
    - `Label` string: A user friendly label of the document requirement
    - `ValidAttachmentCategoryList` object[]
      - `Key` string: Key value, this is what is passed back in with the add document request
      - `Value` string: User friendly display value
  - `TransactionDetails` object: Details about the selected transaction to display to the user.
    - `SummaryHeader` string: Posted Transaction Details header
    - `SelectedPostedTransactionList` object[]
      - `Amount` string: Amount of transaction
      - `AmountInfo` object
        - `Amount` string: Amount of currency
        - `Exponent` string: Number of decimal places for currency
        - `ISOCodeAlpha` string: 3 character alpha iso code
        - `ISOCodeNumeric` string: numeric iso code
        - `ISOCurrencyName` string: currency name
      - `AuthorizationStatus` 'Pending' | 'Posted': Authorization status of the transaction
      - `CardNumberEndingIn` string: Last 4 digits of card number
      - `Date` string: Date of transaction in yyyyMMdd formatted string
      - `DebitCredit` 'Debit' | 'Credit': Debit or Credit
      - `Description` string: Transaction description/Merchant name
      - `PostingDateTime` string: The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `SelectMode` 'Multi' | 'Single': The selection mode for the transaction. * `Multi` — Multiple transactions can be selected for this claim type. * `Single` — Only one transaction can be selected for this claim type.
      - `TransactionDateTime` string: The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `TransactionId` string: ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`
      - `TransactionType` 'ACH' | 'ATMDEP' | 'ATMWD' | 'CardPinless' | 'CardPinned' | 'CHECK' | 'FEE' | 'P2P' | 'WIRE': Type of the transaction
    - `PendingSummaryHeader` string: Pending Transaction Details header
    - `SelectedPendingTransactionList` object[]
      - `Amount` string: Amount of transaction
      - `AmountInfo` object
        - `Amount` string: Amount of currency
        - `Exponent` string: Number of decimal places for currency
        - `ISOCodeAlpha` string: 3 character alpha iso code
        - `ISOCodeNumeric` string: numeric iso code
        - `ISOCurrencyName` string: currency name
      - `AuthorizationStatus` 'Pending' | 'Posted': Authorization status of the transaction
      - `CardNumberEndingIn` string: Last 4 digits of card number
      - `Date` string: Date of transaction in yyyyMMdd formatted string
      - `DebitCredit` 'Debit' | 'Credit': Debit or Credit
      - `Description` string: Transaction description/Merchant name
      - `PostingDateTime` string: The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `SelectMode` 'Multi' | 'Single': The selection mode for the transaction. * `Multi` — Multiple transactions can be selected for this claim type. * `Single` — Only one transaction can be selected for this claim type.
      - `TransactionDateTime` string: The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `TransactionId` string: ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`
      - `TransactionType` 'ACH' | 'ATMDEP' | 'ATMWD' | 'CardPinless' | 'CardPinned' | 'CHECK' | 'FEE' | 'P2P' | 'WIRE': Type of the transaction
    - `RecurringSummaryHeader` string: Recurring Transaction Details header
    - `SelectedRecurringTransactionList` object[]
      - `Amount` string: Amount of transaction
      - `AmountInfo` object
        - `Amount` string: Amount of currency
        - `Exponent` string: Number of decimal places for currency
        - `ISOCodeAlpha` string: 3 character alpha iso code
        - `ISOCodeNumeric` string: numeric iso code
        - `ISOCurrencyName` string: currency name
      - `AuthorizationStatus` 'Pending' | 'Posted': Authorization status of the transaction
      - `CardNumberEndingIn` string: Last 4 digits of card number
      - `Date` string: Date of transaction in yyyyMMdd formatted string
      - `DebitCredit` 'Debit' | 'Credit': Debit or Credit
      - `Description` string: Transaction description/Merchant name
      - `PostingDateTime` string: The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `SelectMode` 'Multi' | 'Single': The selection mode for the transaction. * `Multi` — Multiple transactions can be selected for this claim type. * `Single` — Only one transaction can be selected for this claim type.
      - `TransactionDateTime` string: The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `TransactionId` string: ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`
      - `TransactionType` 'ACH' | 'ATMDEP' | 'ATMWD' | 'CardPinless' | 'CardPinned' | 'CHECK' | 'FEE' | 'P2P' | 'WIRE': Type of the transaction
    - `DeflectedSummaryHeader` string: Deflected Transaction Details header
    - `DeflectedTransactionList` object[]
      - `Amount` string: Amount of transaction
      - `AmountInfo` object
        - `Amount` string: Amount of currency
        - `Exponent` string: Number of decimal places for currency
        - `ISOCodeAlpha` string: 3 character alpha iso code
        - `ISOCodeNumeric` string: numeric iso code
        - `ISOCurrencyName` string: currency name
      - `AuthorizationStatus` 'Pending' | 'Posted': Authorization status of the transaction
      - `CardNumberEndingIn` string: Last 4 digits of card number
      - `Date` string: Date of transaction in yyyyMMdd formatted string
      - `DebitCredit` 'Debit' | 'Credit': Debit or Credit
      - `Description` string: Transaction description/Merchant name
      - `PostingDateTime` string: The posting timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `SelectMode` 'Multi' | 'Single': The selection mode for the transaction. * `Multi` — Multiple transactions can be selected for this claim type. * `Single` — Only one transaction can be selected for this claim type.
      - `TransactionDateTime` string: The authorization timestamp of format yyyyMMdd'T'HHmmss.SSS z
      - `TransactionId` string: ID for the disputed transaction: `P[prog_id]|[prn]|[auth_id]|[network_code]|[trans_code]` Example: `P111|999123456789|0169|M|AUA`
      - `TransactionType` 'ACH' | 'ATMDEP' | 'ATMWD' | 'CardPinless' | 'CardPinned' | 'CHECK' | 'FEE' | 'P2P' | 'WIRE': Type of the transaction
  - `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 retrieve document requirements request
- `500`: Error retrieve document requirements 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)