Skip to main content
GET
/
v1
/
links
/
{link_id}
/
parsed-documents
/
{doc_id}
Retrieve parsed document
curl --request GET \
  --url https://prod.truv.com/v1/links/{link_id}/parsed-documents/{doc_id}/ \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>'
{
  "document_type": "VOLUNTEER_LETTER",
  "id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "document_subtype": "VOL_TRANSCRIPT",
  "file": "https://cdn.truv.com/files_examples/VOLUNTEER_LETTER.pdf",
  "md5sum": "24d7e80942ce4ad58a93f70ce4115f5c",
  "parsed_data": {
    "total_hours": 89.6,
    "time_entries": [
      {
        "date": "2025-01-29",
        "hours": 5.1,
        "description": "Facilitated group activities and sessions"
      },
      {
        "date": "2025-02-02",
        "hours": 5,
        "description": "Assisted with data entry and record keeping"
      },
      {
        "date": "2025-02-05",
        "hours": 5.8,
        "description": "Participated in community cleanup and maintenance"
      },
      {
        "date": "2025-02-07",
        "hours": 3.4,
        "description": "Assisted with food distribution to local families"
      },
      {
        "date": "2025-02-16",
        "hours": 5.6,
        "description": "Led educational workshops for participants"
      }
    ]
  }
}

Authorizations

​
X-Access-Client-Id
string
header
required

Client ID

​
X-Access-Secret
string
header
required

Client Access Key

Path Parameters

​
link_id
string
required

Link ID

​
doc_id
string
required

Parsed Document ID

Response

​
document_type
enum<string>
required
read-only

Document type. Currently only 'VOLUNTEER_LETTER' is supported.

Available options:
VOLUNTEER_LETTER
Example:

"VOLUNTEER_LETTER"

​
id
string
read-only

Parsed document ID

Example:

"24d7e80942ce4ad58a93f70ce4115f5c"

​
document_subtype
enum<string> | null
read-only

Document subtype

Available options:
VOL_TRANSCRIPT,
VOL_HOURS_LOG,
null
Example:

"VOL_TRANSCRIPT"

​
file
string<uri> | null
read-only

Parsed document file link

Example:

"https://cdn.truv.com/files_examples/VOLUNTEER_LETTER.pdf"

​
md5sum
string
read-only

Parsed document md5sum

Example:

"24d7e80942ce4ad58a93f70ce4115f5c"

​
parsed_data
parsed_data · object
read-only

Parsed document data extracted from the volunteer letter. Currently, only volunteer letters are supported.

For volunteer letters, this includes:

  • total_hours: Total volunteer hours (number)
  • time_entries: (Optional) Detailed breakdown of volunteer hours. Array of objects, each containing:
    • date: Date of volunteer activity (YYYY-MM-DD)
    • hours: Hours worked on that date (number)
    • description: Description of the volunteer activity (string)

The structure depends on the document subtype:

  • VOL_TRANSCRIPT: Contains summary fields (total_hours)
  • VOL_HOURS_LOG: Contains both summary (total_hours) and detailed time_entries array
Example:
{
  "total_hours": 89.6,
  "time_entries": [
    {
      "date": "2025-01-29",
      "hours": 5.1,
      "description": "Facilitated group activities and sessions"
    },
    {
      "date": "2025-02-02",
      "hours": 5,
      "description": "Assisted with data entry and record keeping"
    },
    {
      "date": "2025-02-05",
      "hours": 5.8,
      "description": "Participated in community cleanup and maintenance"
    },
    {
      "date": "2025-02-07",
      "hours": 3.4,
      "description": "Assisted with food distribution to local families"
    },
    {
      "date": "2025-02-16",
      "hours": 5.6,
      "description": "Led educational workshops for participants"
    }
  ]
}