Sign in

v1

latestOpenAPI 3.0.32026-07-2621102.1 MB
Documents

/claim/documents/retrieveRequirements

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

post/claim/documents/retrieveRequirements

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

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"
        }
      ]
    }
  ]
}