---
title: "/claim/documents/retrieveRequirements"
method: POST
path: "/claim/documents/retrieveRequirements"
tags: ["Documents"]
---

# /claim/documents/retrieveRequirements

`POST /claim/documents/retrieveRequirements`

Use this endpoint to retrieve required documentation information about an existing claim

## 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 document requirement retrieval

- 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
  - `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 claim document requirement retrieval request
- `500` — Error claim document requirement details retrieve request

---

[API](https://skmtc.net/galileo-ft/apis/program-api.md) · [All operations](https://skmtc.net/galileo-ft/apis/program-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/galileo-ft/program-api/revisions/bcd728f97a18/schema)