v4

OpenAPI 3.0.12026-07-3189233676.2 KB

Parsed Documents

List all parsed documents

The endpoint returns a list of parsed documents. Parsed documents contain structured data extracted from uploaded documents. Note: Currently, only volunteer letters are available through this endpoint. Support for additional document types (paystubs, etc.) will be added in future releases. You can filter, order, and paginate results using query parameters.

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

Query parameters

document_type'VOLUNTEER_LETTER'

Example:VOLUNTEER_LETTER

Filter by document type. Currently only 'VOLUNTEER_LETTER' is supported.

document_subtype'VOL_TRANSCRIPT' | 'VOL_HOURS_LOG'

Example:VOL_TRANSCRIPT

Filter by document subtype. For volunteer letters use VOL_TRANSCRIPT or VOL_HOURS_LOG.

ordering'created_at' | '-created_at'

Order results by field. Prefix with '-' for descending order.

pageinteger

Page number for pagination

page_sizeinteger

Number of results per page

Response

countinteger required

Total number of parsed documents

nextstring uri nullable

URL to next page

previousstring uri nullable

URL to previous page

Example response

{
  "count": 42,
  "next": "https://prod.truv.com/v1/links/{link_id}/parsed-documents/?page=2",
  "results": [
    {
      "id": "24d7e80942ce4ad58a93f70ce4115f5c",
      "document_type": "VOLUNTEER_LETTER",
      "document_subtype": "VOL_TRANSCRIPT",
      "file": "https://cdn.truv.com/files_examples/VOLUNTEER_LETTER.pdf",
      "md5sum": "24d7e80942ce4ad58a93f70ce4115f5c"
    }
  ]
}