TRtruv
Parsed Documents

Retrieve parsed document

Changed on

The endpoint returns a parsed document with its extracted data. The parsed_data field contains structured information extracted from the document. Note: Volunteer letters and military PCS orders 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. For PCS orders, the parsed_data includes the service branch, pay grade, current and future duty stations, the report no later than (RNLT) date, tour length, dependent information, and the active duty service commitment.

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

Request

  • Base URL
    https://prod.truv.com
  • URL
    https://prod.truv.com/v1/links/{link_id}/parsed-documents/{doc_id}/
  • Auth
    API key in header X-Access-Client-Id and API key in header X-Access-Secret

Response

idstring

Parsed document ID

document_type'VOLUNTEER_LETTER' | 'PCS_ORDERS' required

Document type.

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

Document subtype. Set for volunteer letters only; null for PCS orders.

filestring uri nullable

Parsed document file link

md5sumstring

Parsed document md5sum

parsed_dataobject nullable

Parsed document data. The set of fields depends on the document type.

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

For PCS orders, this includes:

  • branch: Issuing service branch — Army, Navy, USMC, Air Force, Coast Guard or Space Force (string)

  • rank: Service member's rank normalized to a pay grade, e.g. E-5 or O-3 (string)

  • current_duty_station: Location the member is departing from (string)

  • future_duty_station: Location the member is reporting to (string)

  • report_no_later_than_date: Report no later than (RNLT) date, YYYY-MM-DD (string)

  • tour_length: Tour length when the order states one, e.g. 36 months (string)

  • dependents: Dependent information when the order states any. Object containing:

    • count: Number of dependents (number)
    • names: Dependent names when the order lists them (array of strings)
    • accompanied: Whether dependent travel is authorized (boolean)

  • active_duty_service_commitment: Service commitment tied to the move, a duration or a date (string)

Every PCS orders field is null when the order does not state it. Nothing is inferred.

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

Changes

  • a14fbb94e588Revision changes
    • warning

      added the new PCS_ORDERS enum value to the response property for the response status