v4

OpenAPI 3.0.12026-07-3189233676.2 KB

Parsed Documents

Retrieve parsed document

The endpoint returns a parsed document with its extracted data. The parsed_data field contains structured information extracted from the document. Note: Currently, only volunteer letters are available through this endpoint. For volunteer letters, the parsed_data includes volunteer information such as total hours, dates (start_date, end_date), position title, and optionally detailed hour entries with dates, hours, and descriptions for each volunteer activity.

get/v1/links/{link_id}/parsed-documents/{doc_id}/

Response

idstring

Parsed document ID

document_type'VOLUNTEER_LETTER' required

Document type. Currently only 'VOLUNTEER_LETTER' is supported.

document_subtype'VOL_TRANSCRIPT' | 'VOL_HOURS_LOG' | 'null' nullable

Document subtype

filestring uri nullable

Parsed document file link

md5sumstring

Parsed document md5sum

parsed_dataobject nullable

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 response

{
  "id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "document_type": "VOLUNTEER_LETTER",
  "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"
      }
    ]
  }
}