--- title: "List Documents" method: GET path: "/end_users/{end_user_id}/documents" tags: ["End Users"] --- # List Documents `GET /end_users/{end_user_id}/documents` Lists all documents associated with your end user ID. This is a paginated endpoint; see how Pinwheel implements pagination here. ## Path parameters - `end_user_id` string, required — User ID provided by you, to associate Pinwheel users with your user model. ## Query parameters - `type` 'direct_deposit_form' — The type of the document. ## Headers - `Pinwheel-Version` '2025-07-08' | '2023-11-22' | '2023-07-18' | '2023-04-18' | '2022-09-09' | '2022-06-22' | '2022-03-02', required ## Response `200` OK - object - `meta` PaginationMeta, required - `count` integer — Number of objects returned. - `next_cursor` string — Pointer to the next page of results. - `data` EndUserDocumentObjResponse[], required - `id` string, uuid, required — Unique identifier of the document object. - `created_at` string, date-time, required — ISO 8601 timestamp of created time. - `end_user_id` string, required — User ID provided by you, to associate Pinwheel users with your user model. Required if `account_id` is not provided. This ID will be returned in all webhook events and all account-affiliated API responses. Leading and trailing whitespace will be stripped. Do not include PII in this identifier. - `document` DocumentObjPublicResponseItem, required - `id` string, uuid, required — Unique identifier of the document object. - `download_url` string — URL from which the document may be downloaded. - `download_url_expiration` string, date-time — ISO 8601 timestamp of when the download URL will no longer be valid. - `document_type` 'paystub' | 'W-2' | '1099' | 'direct_deposit_form' | 'verification_report' | '1040' | 'bank_statement' | 'ssi_award_letter' | 'w2' | 'verification_photo', required — The type of the document. - `parsed_data` union — The parsed data of the document. - UploadedPaystub - `document_type` 'paystub' — The type of the document. - `pay_date` string — The date when the check amount is paid to the employee. - `pay_period_start` string — The date when the pay period begins. Some platforms, like unemployment portals, do not have fixed pay periods. - `pay_period_end` string — The date when the pay period ends. Some platforms, like unemployment portals, do not have fixed pay periods. - `gross_pay_amount` integer — The total earnings before any deductions are made, in cents. - `gross_pay_ytd` integer — The cumulative year to date total earnings before any taxes or deductions are removed, in cents. - `net_pay_amount` integer — The total earnings after all taxes and deductions are removed, in cents. - `net_pay_ytd` integer — The cumulative year to date total earnings after all taxes and deductions are removed, in cents. - `earnings` UploadedEarning[] — The earnings for this pay period, in cents. - `type` string — The category of earning. - `description` string — The description of the earning. - `amount` integer — The amount of earning, in cents. - `amount_ytd` integer — The amount ytd of earning, in cents. - `taxes` UploadedTax[] — The taxes for this pay period, in cents. - `type` string — The category of tax. - `description` string — The description of tax. - `amount` integer — The amount of tax, in cents. - `amount_ytd` integer — The amount ytd of tax, in cents. - `deductions` UploadedDeduction[] — The deductions for this pay period, in cents. - `type` string — The category of deduction. - `description` string — The description of deduction. - `amount` integer — The amount of deduction, in cents. - `amount_ytd` integer — The amount ytd of deduction, in cents. - `employer` EmployerNameAndAddress - `name` string — Name of employer, e.g., Apple, Disney, Walmart. - `address` AddressGetResponseItem - `raw` string, required — The raw address. - `line1` string — The first line of the address. - `line2` string — The second line of the address. - `city` string — The city of the address. - `state` string — The state of the address. - `postal_code` string — The postal code of the address. - `country` 'US' — The country of the address. - `employee` EmployeeNameAndAddress - `name` string — The full name of the employee. - `address` AddressGetResponseItem - `raw` string, required — The raw address. - `line1` string — The first line of the address. - `line2` string — The second line of the address. - `city` string — The city of the address. - `state` string — The state of the address. - `postal_code` string — The postal code of the address. - `country` 'US' — The country of the address. - `time_off` UploadedTimeOff[] — The user's time off balances for this pay period. To enable time off balances, please contact Pinwheel support. - `name` string — The name of the time off. - `category` 'pto' | 'sick' | 'other' — The category of the time off. - `available_hours` number — The total hours of time off available, as of the pay period end date. In the event available_hours is not on the paystub, this value reflects the current available_hours at the time the paystub was retrieved. - `earned_hours` number — The hours of time off earned during the pay period. - `used_hours` number — The hours of time off used during the pay period. - UploadedBankStatement - `document_type` 'bank_statement' — The type of the document. - `bank_name` string — The name of the bank associated with this bank statement. - `statement_begin_date` string — The beginning date of the bank statement. - `statement_end_date` string — The end date of the bank statement. - `statement_holders` string[] — The holders of the bank statement. - `applicant1` ApplicantNameAndAddress - `name` string — The full name of the applicant. - `address` AddressGetResponseItem - `raw` string, required — The raw address. - `line1` string — The first line of the address. - `line2` string — The second line of the address. - `city` string — The city of the address. - `state` string — The state of the address. - `postal_code` string — The postal code of the address. - `country` 'US' — The country of the address. - `applicant2` ApplicantNameAndAddress - `name` string — The full name of the applicant. - `address` AddressGetResponseItem - `raw` string, required — The raw address. - `line1` string — The first line of the address. - `line2` string — The second line of the address. - `city` string — The city of the address. - `state` string — The state of the address. - `postal_code` string — The postal code of the address. - `country` 'US' — The country of the address. - `accounts` BankAccount[] — The accounts associated with this bank statement. - `account_number` union — The account number of the bank account. - number - string - `account_name` string — The name of the bank account. - `bank_account_type` string — The type of the bank account. - `is_joint_account` boolean — Whether the bank account is a joint account. - `total_deposits` union — The total deposits of the bank account. - number - string - `beginning_balance` union — The beginning balance of the bank account. - number - string - `ending_balance` union — The ending balance of the bank account. - number - string - `transactions` BankAccountTransaction[] — The transactions of the bank account. - `date` string — The date of the transaction. - `description` string — The description of the transaction. - `amount` union — The amount of the transaction. - … - `base_type` string — The base type of the transaction. - `type` string — The type of the transaction. - UploadedSSIAwardLetter - `document_type` 'ssi_award_letter' — The type of the document. - `applicant` ApplicantNameAndAddress - `name` string — The full name of the applicant. - `address` AddressGetResponseItem - `raw` string, required — The raw address. - `line1` string — The first line of the address. - `line2` string — The second line of the address. - `city` string — The city of the address. - `state` string — The state of the address. - `postal_code` string — The postal code of the address. - `country` 'US' — The country of the address. - `issue_date` string — The date the award letter was issued. - `pay_date` string — The date the award letter was paid. - `social_security_payment` integer — The social security payment. - `social_security_deduction` integer — The social security deduction. - `social_security_net_payment` integer — The social security net payment. - `supplemental_security_payment` integer — The supplemental security payment. - UploadedW2Informed - `document_type` 'w2' — The type of the document. - `applicant` ApplicantNameAndAddress - `name` string — The full name of the applicant. - `address` AddressGetResponseItem - `raw` string, required — The raw address. - `line1` string — The first line of the address. - `line2` string — The second line of the address. - `city` string — The city of the address. - `state` string — The state of the address. - `postal_code` string — The postal code of the address. - `country` 'US' — The country of the address. - `employer_name` string — The employer name associated with the W2. - `total_wages` union — The total wages associated with the W2. - number - string - `state_wages` union — The state wages associated with the W2. - number - string - `social_security_wages` union — The social security wages associated with the W2. - number - string - `medicare_wages` union — The medicare wages associated with the W2. - number - string - `federal_taxes` union — The federal taxes associated with the W2. - number - string - `state_taxes` union — The state taxes associated with the W2. - number - string - `social_security_taxes` union — The social security taxes associated with the W2. - number - string - `medicare_taxes` union — The medicare taxes associated with the W2. - number - string - `tax_year` string — The tax year associated with the W2. - `warnings` FieldWarning[] — Used to indicate if there are any warnings for fields returned in this response. - `field` string, required — The response field associated with this warning. Nested values are delimited with a `.`, i.e. `parsed_data.box_13.statutory_employee`. - `status` 'unparsable', required — The status type of this warning. - `message` string, required — A full description of the warning. - `fraud` SharedFraud - `status` 'suspected' | 'not_suspected' | 'unavailable', required — The suspected fraud status of the document. --- [API](https://skmtc.net/getpinwheel/apis/pinwheel.md) · [All operations](https://skmtc.net/getpinwheel/apis/pinwheel/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getpinwheel/pinwheel/versions/bf20c4d4c5d3/schema)