Get Documents
Header Parameters
Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.
Query Parameters
Unique Person Identifier obtained by looking up a Consumer in the Benefits Platform Identity System.
Optional year to filter documents by. When omitted, results across all years are returned.
The type of document to retrieve (ACCOUNT_STATEMENTS, TAX_DOCUMENTS, HSA_SUMMARY). When omitted, returns all document types.
The number of records returned at once. Can be from 1-100, default is 25.
The zero-based page number to retrieve. Defaults to 0 (first page).
Response
Successfully retrieved documents. Returns empty arrays when the person is not found or has no documents for the given filters.
Response Attributes
The current zero-based page number of the paginated results.
The number of items returned per page in the results.
The total number of matching documents across all pages, regardless of document type.
Indicates if there are additional pages of results in the combined documents collection.
A single paginated list of documents for the requested person and filters. Each item includes a document_type field indicating whether it is an account statement, tax document, or HSA summary. When document_type query parameter is specified, only documents of that type are returned. Empty array when no documents match the given filters.
Show child attributes
Invalid request parameters. Returned when person_id is empty or year is out of range.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unauthorized. Authentication failed.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.
Unexpected error.
Response Attributes
List of invalid parameters that caused the validation error.
Show child attributes
Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.
Field-level validation errors keyed by field name. Each key maps to one or more structured error details.