--- title: "Pay stub data" method: GET path: "/v2/paystub/{paystub_uuid}" tags: ["Capture"] --- # Pay stub data `GET /v2/paystub/{paystub_uuid}` ## Request - Base URL: `https://api.ocrolus.com` - URL: `https://api.ocrolus.com/v2/paystub/{paystub_uuid}` - Auth: OAuth 2 - Client credentials - Token URL: `https://auth.ocrolus.com/oauth/token` Retrieves pay stub data for a given <>. --- A detailed description of the response can be found on the [pay stub](https://docs.ocrolus.com/docs/pay-stub) data type definition. ## Path parameters - `paystub_uuid` string, required ## Response `200` Success - object - `status` integer: A numerical code that indicates the status of the request. - `message` string: A textual description that indicates details about this response's status. - `response` object: An object received from the server that potentially contains data. - `uuid` string: Universally unique identifier (UUID) for the pay stub. - `book_uuid` string: Universally unique identifier (UUID) for the <>. - `doc_uuid` string: Universally unique identifier (UUID) for the <>. - `status` string: Verification status of the pay stub <>. - `doc_page_numbers` integer[]: An array of numbers that indicate the number of pages in each Document uploaded to the <>. - `rejection_reason` string: An optional attribute that briefly explains why a Document was rejected. - `uploaded_image_bucket_uuid` string: Universally unique identifier (UUID) for the image bucket. - `net_pay` object: The net pay recorded in the pay stub. - `distribution_details` object[]: Details related to the distribution of the net pay. - `description` string: A description related to the net pay. - `bank_name` string: The bank name recorded in the net pay. - `account_number` string: The account number recorded in the net pay. - `bank_account_type` string: The bank account type recorded in the net pay. - `current_pay` object: The current pay amount recorded in the net pay. - `amount` string: The the numerical value of the current pay. - `currency` string: The currency that the current pay was delivered in. - `totals` object: Totals recorded in the pay stub. - `description` string: A description realted to the total. - `canonical_description` string: A canonical description realted to the total. - `current_pay` object: The current pay amount recorded in the net pay. - `amount` string: The the numerical value of the current pay. - `currency` string: The currency that the current pay was delivered in. - `ytd_pay` object: The year to date pay amount recorded in the net pay. - `amount` string: The the numerical value of the year to date pay. - `currency` string: The currency that the year to date pay was delivered in. - `earnings` object: Earnings recorded in the pay stub. - `subtotals` object[]: Subtotals related to the earnings. - `description` string: A description of a subtotal. - `canonical_description` string: A canonical description of a subtotal. - `current_pay` object: The current pay amount recorded in the subtotal. - `amount` string: The the numerical value of the current pay. - `currency` string: The currency that the current pay was delivered in. - `ytd_pay` object: The year to date pay amount recorded in the subtotal. - `amount` string: The the numerical value of the year to date pay. - `currency` string: The currency that the year to date pay was delivered in. - `current_hours` string: The current hours recorded related to the subtotal. - `current_rate` string: The current rate recorded related to the subtotal. - `totals` object[]: Totals related to the earnings. - `description` string - `canonical_description` string: A canonical description of a total. - `current_pay` object: The current pay amount recorded in the total. - `amount` string: The the numerical value of the current pay. - `currency` string: The currency that the current pay was delivered in. - `ytd_pay` object: The year to date pay amount recorded in the total. - `amount` string: The the numerical value of the year to date pay. - `currency` string: The currency that the year to date pay was delivered in. - `current_hours` string: The current hours recorded related to the total. - `deductions` object: Deductions recorded in the paystub. - `subtotals` object[]: Subtotals related to the deductions. - `description` string: A description of a subtotal. - `canonical_description` string: A canonical description of a subtotal. - `current_pay` object: The current pay amount recorded in the total. - `amount` string: The the numerical value of the current pay. - `currency` string: The currency that the current pay was delivered in. - `ytd_pay` object: The year to date pay amount recorded in the subtotal. - `amount` string: The the numerical value of the year to date pay. - `currency` string: The currency that the year to date pay was delivered in. - `totals` object[]: Totals related to the deductions. - `description` string: A description of a total. - `canonical_description` string: A canonical description of a total. - `current_pay` object: The current pay amount recorded in the total. - `amount` string: The the numerical value of the current pay. - `currency` string: The currency that the current pay was delivered in. - `ytd_pay` object: The year to date pay amount recorded in the total. - `amount` string: The the numerical value of the year to date pay. - `currency` string: The currency that the year to date pay was delivered in. - `employer` object: The employer recorded in the pay stub. - `name` string: The name of the employer. - `address` object: The address of the employer. - `line1` string: Line 1 of the employer's address. - `line2` string: Line 2 of the employer's address. - `city` string: City of the employer's address. - `state_code` string: State code of the employer's address. - `postal_code` string: Postal code of the employer's address. - `employee` object: The employee recorded in the pay stub. - `name` string: The name of the employer. - `address` object: The address of the employee. - `line1` string: Line 1 of the employee's address. - `line2` string: Line 2 of the employee's address. - `city` string: City of the employee's address. - `state_code` string: State code of the employee's address. - `postal_code` string: Postal code of the employee's address. - `marital_status` string: Indicates if the employee is married. - `taxpayer_id` object: The taxpayer ID of the employee. - `id_type` string: The type of ID used to identify the employee. - `last_4_digits` string: The last four digits of the employee's taxpayer ID. - `paystub_details` object: Details of the paystub. - `pay_period_start_date` string: The start date of the pay period recorded in the pay stub. - `pay_period_end_date` string: The end date of the pay period recorded in the pay stub. - `pay_date` string: The date of the pay period recorded in the pay stub. - `paystub_provider` string: The provider of the pay stub. - `pay_frequency` string: How often the pay stub is delivered. - `pay_frequency_captured` string: Indicates if the pay frequency is recorded in the pay stub. - `employment_details` object: Details related to the employment. - `hire_date` string: The date when the employee was hired. - `annual_salary` object: The annual salary of the employee. - `amount` string: The total value of the salary. - `currency` string: The currency the salary will be paid in. - `confidence_scores` object[]: An array containing information about the confidence scores associated with fields in this document. - `confidence` integer: A number representing the confidence score. - `key` string: The value that this confidence score is attributed to. ## Other responses - `400`: Client Errors - `500`: Internal Server Error --- [API](https://skmtc.dev/ocrolus/apis/capture.md) - [All operations](https://skmtc.dev/ocrolus/apis/capture/llms.txt) - [OpenAPI document](https://skmtc.dev/ocrolus/apis/capture/revisions/4bc747954163?raw)