--- title: "(Deprecated) Retrieve information from the paystubs used for income verification" method: POST path: "/income/verification/paystubs/get" tags: ["plaid"] deprecated: true --- # (Deprecated) Retrieve information from the paystubs used for income verification `POST /income/verification/paystubs/get` > **Deprecated.** `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead. ## Request body - IncomeVerificationPaystubsGetRequest — IncomeVerificationPaystubsGetRequest defines the request schema for `/income/verification/paystubs/get`. - `client_id` string — Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body. - `secret` string — Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body. - `income_verification_id` string, nullable — The ID of the verification for which to get paystub information. - `access_token` string, nullable — The access token associated with the Item for which data is being requested. ## Response `200` OK - IncomeVerificationPaystubsGetResponse — IncomeVerificationPaystubsGetResponse defines the response schema for `/income/verification/paystubs/get`. - `document_metadata` DocumentMetadata[] — Metadata for an income document. - `name` string — The name of the document. - `status` string, nullable — The processing status of the document. `PROCESSING_COMPLETE`: The document was successfully processed. `DOCUMENT_ERROR`: The document could not be processed. Possible causes include: The document was an unacceptable document type such as an offer letter or bank statement, the document image was cropped or blurry, or the document was corrupted. `UNKNOWN` or `null`: An internal error occurred. If this happens repeatedly, contact support or your Plaid account manager. - `doc_id` string — An identifier of the document that is also present in the paystub response. - `doc_type` 'UNKNOWN' | 'DOCUMENT_TYPE_PAYSTUB' | 'DOCUMENT_TYPE_BANK_STATEMENT' | 'DOCUMENT_TYPE_US_TAX_W2' | 'DOCUMENT_TYPE_US_MILITARY_ERAS' | 'DOCUMENT_TYPE_US_MILITARY_LES' | 'DOCUMENT_TYPE_US_MILITARY_CLES' | 'DOCUMENT_TYPE_GIG' | 'DOCUMENT_TYPE_NONE' | 'DOCUMENT_TYPE_US_TAX_1099_MISC' | 'DOCUMENT_TYPE_US_TAX_1099_K' | 'DOCUMENT_TYPE_PLAID_GENERATED_PAYSTUB_PDF' | 'DOCUMENT_TYPE_US_STUDENT_I20' — The type of document. `DOCUMENT_TYPE_PAYSTUB`: A paystub. `DOCUMENT_TYPE_BANK_STATEMENT`: A bank statement. `DOCUMENT_TYPE_US_TAX_W2`: A W-2 wage and tax statement provided by a US employer reflecting wages earned by the employee. `DOCUMENT_TYPE_US_MILITARY_ERAS`: An electronic Retirement Account Statement (eRAS) issued by the US military. `DOCUMENT_TYPE_US_MILITARY_LES`: A Leave and Earnings Statement (LES) issued by the US military. `DOCUMENT_TYPE_US_MILITARY_CLES`: A Civilian Leave and Earnings Statement (CLES) issued by the US military. `DOCUMENT_TYPE_GIG`: Used to indicate that the income is related to gig work. Does not necessarily correspond to a specific document type. `DOCUMENT_TYPE_NONE`: Used to indicate that there is no underlying document for the data. `DOCUMENT_TYPE_US_TAX_1099_MISC`: A Form 1099-MISC information return reporting miscellaneous income. `DOCUMENT_TYPE_US_TAX_1099_K`: A Form 1099-K information return reporting payment card and third-party network transactions. `DOCUMENT_TYPE_PLAID_GENERATED_PAYSTUB_PDF`: Used to indicate that the PDF for the paystub was generated by Plaid. `DOCUMENT_TYPE_US_STUDENT_I20`: A Form I-20 Certificate of Eligibility for Nonimmigrant Student Status. `UNKNOWN`: Document type could not be determined. - `paystubs` Paystub[], required - `deductions` Deductions, required — An object with the deduction information found on a paystub. - `subtotals` Total[] - `canonical_description` 'BONUS' | 'COMMISSION' | 'OVERTIME' | 'PAID TIME OFF' | 'REGULAR PAY' | 'VACATION' | 'EMPLOYEE MEDICARE' | 'FICA' | 'SOCIAL SECURITY EMPLOYEE TAX' | 'MEDICAL' | 'VISION' | 'DENTAL' | 'NET PAY' | 'TAXES' | 'NOT_FOUND' | 'OTHER' | 'null', nullable — Commonly used term to describe the line item. - `description` string, nullable — Text of the line item as printed on the paystub. - `current_pay` Pay — An object representing a monetary amount. - `amount` number, double, nullable — A numerical amount of a specific currency. - `currency` string, nullable — Currency code, e.g. USD - `ytd_pay` Pay — An object representing a monetary amount. - `amount` number, double, nullable — A numerical amount of a specific currency. - `currency` string, nullable — Currency code, e.g. USD - `breakdown` DeductionsBreakdown[], required - `current_amount` number, double, nullable — Raw amount of the deduction - `description` string, nullable — Description of the deduction line item - `iso_currency_code` string, nullable — The ISO-4217 currency code of the line item. Always `null` if `unofficial_currency_code` is non-null. - `unofficial_currency_code` string, nullable — The unofficial currency code associated with the line item. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s. - `ytd_amount` number, double, nullable — The year-to-date amount of the deduction - `totals` Total[] - `canonical_description` 'BONUS' | 'COMMISSION' | 'OVERTIME' | 'PAID TIME OFF' | 'REGULAR PAY' | 'VACATION' | 'EMPLOYEE MEDICARE' | 'FICA' | 'SOCIAL SECURITY EMPLOYEE TAX' | 'MEDICAL' | 'VISION' | 'DENTAL' | 'NET PAY' | 'TAXES' | 'NOT_FOUND' | 'OTHER' | 'null', nullable — Commonly used term to describe the line item. - `description` string, nullable — Text of the line item as printed on the paystub. - `current_pay` Pay — An object representing a monetary amount. - `amount` number, double, nullable — A numerical amount of a specific currency. - `currency` string, nullable — Currency code, e.g. USD - `ytd_pay` Pay — An object representing a monetary amount. - `amount` number, double, nullable — A numerical amount of a specific currency. - `currency` string, nullable — Currency code, e.g. USD - `total` DeductionsTotal, required — An object representing the total deductions for the pay period - `current_amount` number, double, nullable — Raw amount of the deduction - `iso_currency_code` string, nullable — The ISO-4217 currency code of the line item. Always `null` if `unofficial_currency_code` is non-null. - `unofficial_currency_code` string, nullable — The unofficial currency code associated with the line item. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s. - `ytd_amount` number, double, nullable — The year-to-date total amount of the deductions - `doc_id` string, required — An identifier of the document referenced by the document metadata. - `earnings` Earnings, required — An object representing both a breakdown of earnings on a paystub and the total earnings. - `subtotals` EarningsTotal[] - `current_amount` number, double, nullable — Total amount of the earnings for this pay period - `current_pay` Pay — An object representing a monetary amount. - `amount` number, double, nullable — A numerical amount of a specific currency. - `currency` string, nullable — Currency code, e.g. USD - `ytd_pay` Pay — An object representing a monetary amount. - `amount` number, double, nullable — A numerical amount of a specific currency. - `currency` string, nullable — Currency code, e.g. USD - `hours` number, nullable — Total number of hours worked for this pay period - `iso_currency_code` string, nullable — The ISO-4217 currency code of the line item. Always `null` if `unofficial_currency_code` is non-null. - `unofficial_currency_code` string, nullable — The unofficial currency code associated with the line item. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s. - `ytd_amount` number, double, nullable — The total year-to-date amount of the earnings - `totals` EarningsTotal[] - `current_amount` number, double, nullable — Total amount of the earnings for this pay period - `current_pay` Pay — An object representing a monetary amount. - `amount` number, double, nullable — A numerical amount of a specific currency. - `currency` string, nullable — Currency code, e.g. USD - `ytd_pay` Pay — An object representing a monetary amount. - `amount` number, double, nullable — A numerical amount of a specific currency. - `currency` string, nullable — Currency code, e.g. USD - `hours` number, nullable — Total number of hours worked for this pay period - `iso_currency_code` string, nullable — The ISO-4217 currency code of the line item. Always `null` if `unofficial_currency_code` is non-null. - `unofficial_currency_code` string, nullable — The unofficial currency code associated with the line item. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s. - `ytd_amount` number, double, nullable — The total year-to-date amount of the earnings - `breakdown` EarningsBreakdown[] - `canonical_description` 'BONUS' | 'COMMISSION' | 'OVERTIME' | 'PAID TIME OFF' | 'REGULAR PAY' | 'VACATION' | 'BASIC ALLOWANCE HOUSING' | 'BASIC ALLOWANCE SUBSISTENCE' | 'OTHER' | 'null', nullable — Commonly used term to describe the earning line item. - `current_amount` number, double, nullable — Raw amount of the earning line item. - `description` string, nullable — Description of the earning line item. - `hours` number, nullable — Number of hours applicable for this earning. - `iso_currency_code` string, nullable — The ISO-4217 currency code of the line item. Always `null` if `unofficial_currency_code` is non-null. - `rate` number, double, nullable — Hourly rate applicable for this earning. - `unofficial_currency_code` string, nullable — The unofficial currency code associated with the line item. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s. - `ytd_amount` number, double, nullable — The year-to-date amount of the line item. - `total` EarningsTotal — An object representing both the current pay period and year to date amount for an earning category. - `current_amount` number, double, nullable — Total amount of the earnings for this pay period - `current_pay` Pay — An object representing a monetary amount. - `amount` number, double, nullable — A numerical amount of a specific currency. - `currency` string, nullable — Currency code, e.g. USD - `ytd_pay` Pay — An object representing a monetary amount. - `amount` number, double, nullable — A numerical amount of a specific currency. - `currency` string, nullable — Currency code, e.g. USD - `hours` number, nullable — Total number of hours worked for this pay period - `iso_currency_code` string, nullable — The ISO-4217 currency code of the line item. Always `null` if `unofficial_currency_code` is non-null. - `unofficial_currency_code` string, nullable — The unofficial currency code associated with the line item. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s. - `ytd_amount` number, double, nullable — The total year-to-date amount of the earnings - `employee` Employee, required — Data about the employee. - `address` PaystubAddress, required — Address on the paystub - `city` string, nullable — The full city name. - `country` string, nullable — The ISO 3166-1 alpha-2 country code. - `postal_code` string, nullable — The postal code of the address. - `region` string, nullable — The region or state Example: `"NC"` - `street` string, nullable — The full street address. - `line1` string, nullable — Street address line 1. - `line2` string, nullable — Street address line 2. - `state_code` string, nullable — The region or state Example: `"NC"` - `name` string, nullable, required — The name of the employee. - `marital_status` string, nullable — Marital status of the employee - either `single` or `married`. - `taxpayer_id` TaxpayerID — Taxpayer ID of the individual receiving the paystub. - `id_type` string, nullable — Type of ID, e.g. 'SSN' - `id_mask` string, nullable — ID mask; i.e. last 4 digits of the taxpayer ID - `last_4_digits` string, nullable — Last 4 digits of unique number of ID. - `employer` PaystubEmployer, required — Information about the employer on the paystub - `address` PaystubAddress — Address on the paystub - `city` string, nullable — The full city name. - `country` string, nullable — The ISO 3166-1 alpha-2 country code. - `postal_code` string, nullable — The postal code of the address. - `region` string, nullable — The region or state Example: `"NC"` - `street` string, nullable — The full street address. - `line1` string, nullable — Street address line 1. - `line2` string, nullable — Street address line 2. - `state_code` string, nullable — The region or state Example: `"NC"` - `name` string, nullable, required — The name of the employer on the paystub. - `employment_details` EmploymentDetails — An object representing employment details found on a paystub. - `annual_salary` Pay — An object representing a monetary amount. - `amount` number, double, nullable — A numerical amount of a specific currency. - `currency` string, nullable — Currency code, e.g. USD - `hire_date` string, date, nullable — Date on which the employee was hired, in the YYYY-MM-DD format. - `net_pay` NetPay, required — An object representing information about the net pay amount on the paystub. - `current_amount` number, double, nullable — Raw amount of the net pay for the pay period - `description` string, nullable — Description of the net pay - `iso_currency_code` string, nullable — The ISO-4217 currency code of the net pay. Always `null` if `unofficial_currency_code` is non-null. - `unofficial_currency_code` string, nullable — The unofficial currency code associated with the net pay. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s. - `ytd_amount` number, double, nullable — The year-to-date amount of the net pay - `total` Total — An object representing both the current pay period and year to date amount for a category. - `canonical_description` 'BONUS' | 'COMMISSION' | 'OVERTIME' | 'PAID TIME OFF' | 'REGULAR PAY' | 'VACATION' | 'EMPLOYEE MEDICARE' | 'FICA' | 'SOCIAL SECURITY EMPLOYEE TAX' | 'MEDICAL' | 'VISION' | 'DENTAL' | 'NET PAY' | 'TAXES' | 'NOT_FOUND' | 'OTHER' | 'null', nullable — Commonly used term to describe the line item. - `description` string, nullable — Text of the line item as printed on the paystub. - `current_pay` Pay — An object representing a monetary amount. - `amount` number, double, nullable — A numerical amount of a specific currency. - `currency` string, nullable — Currency code, e.g. USD - `ytd_pay` Pay — An object representing a monetary amount. - `amount` number, double, nullable — A numerical amount of a specific currency. - `currency` string, nullable — Currency code, e.g. USD - `pay_period_details` PayPeriodDetails, required — Details about the pay period. - `check_amount` number, double, nullable — The amount of the paycheck. - `distribution_breakdown` DistributionBreakdown[] - `account_name` string, nullable — Name of the account for the given distribution. - `bank_name` string, nullable — The name of the bank that the payment is being deposited to. - `current_amount` number, double, nullable — The amount distributed to this account. - `iso_currency_code` string, nullable — The ISO-4217 currency code of the net pay. Always `null` if `unofficial_currency_code` is non-null. - `mask` string, nullable — The last 2-4 alphanumeric characters of an account's official account number. - `type` string, nullable — Type of the account that the paystub was sent to (e.g. 'checking'). - `unofficial_currency_code` string, nullable — The unofficial currency code associated with the net pay. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s. - `current_pay` Pay — An object representing a monetary amount. - `amount` number, double, nullable — A numerical amount of a specific currency. - `currency` string, nullable — Currency code, e.g. USD - `end_date` string, date, nullable — The pay period end date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: "yyyy-mm-dd". - `gross_earnings` number, double, nullable — Total earnings before tax/deductions. - `pay_date` string, date, nullable — The date on which the paystub was issued, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ("yyyy-mm-dd"). - `pay_frequency` 'PAY_FREQUENCY_UNKNOWN' | 'PAY_FREQUENCY_WEEKLY' | 'PAY_FREQUENCY_BIWEEKLY' | 'PAY_FREQUENCY_SEMIMONTHLY' | 'PAY_FREQUENCY_MONTHLY' | 'null', nullable — The frequency at which an individual is paid. - `pay_day` string, date, nullable — The date on which the paystub was issued, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ("yyyy-mm-dd"). - `start_date` string, date, nullable — The pay period start date, in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format: "yyyy-mm-dd". - `paystub_details` PaystubDetails — An object representing details that can be found on the paystub. - `pay_period_start_date` string, date, nullable — Beginning date of the pay period on the paystub in the 'YYYY-MM-DD' format. - `pay_period_end_date` string, date, nullable — Ending date of the pay period on the paystub in the 'YYYY-MM-DD' format. - `pay_date` string, date, nullable — Pay date on the paystub in the 'YYYY-MM-DD' format. - `paystub_provider` string, nullable — The name of the payroll provider that generated the paystub, e.g. ADP - `pay_frequency` 'MONTHLY' | 'BI-WEEKLY' | 'WEEKLY' | 'SEMI-MONTHLY' | 'null', nullable — The frequency at which the employee is paid. Possible values: `MONTHLY`, `BI-WEEKLY`, `WEEKLY`, `SEMI-MONTHLY`. - `income_breakdown` IncomeBreakdown[] - `type` 'bonus' | 'overtime' | 'regular' | 'null', nullable, required — The type of income. Possible values include: `"regular"`: regular income `"overtime"`: overtime income `"bonus"`: bonus income - `rate` number, double, nullable, required — The hourly rate at which the income is paid. - `hours` number, nullable, required — The number of hours logged for this income for this pay period. - `total` number, double, nullable, required — The total pay for this pay period. - `ytd_earnings` PaystubYTDDetails — The amount of income earned year to date, as based on paystub data. - `gross_earnings` number, double, nullable — Year-to-date gross earnings. - `net_earnings` number, double, nullable — Year-to-date net (take home) earnings. - `error` PlaidError, nullable — Errors are identified by `error_code` and categorized by `error_type`. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-`null` error object will only be part of an API response when calling `/item/get` to view Item status. Otherwise, error fields will be `null` if no error has occurred; if an error has occurred, an error code will be returned instead. - `error_type` 'INVALID_REQUEST' | 'INVALID_RESULT' | 'INVALID_INPUT' | 'INSTITUTION_ERROR' | 'RATE_LIMIT_EXCEEDED' | 'API_ERROR' | 'ITEM_ERROR' | 'ASSET_REPORT_ERROR' | 'BASE_REPORT_ERROR' | 'RECAPTCHA_ERROR' | 'OAUTH_ERROR' | 'PAYMENT_ERROR' | 'BANK_TRANSFER_ERROR' | 'INCOME_VERIFICATION_ERROR' | 'MICRODEPOSITS_ERROR' | 'SANDBOX_ERROR' | 'PARTNER_ERROR' | 'SIGNAL_ERROR' | 'TRANSACTIONS_ERROR' | 'TRANSACTION_ERROR' | 'TRANSFER_ERROR' | 'CHECK_REPORT_ERROR' | 'CONSUMER_REPORT_ERROR' | 'USER_ERROR' | 'IDEMPOTENCY_ERROR' | 'ASSETS_ERROR' | 'CRA_MONITORING_ERROR' | 'CREDIT_PROFILE_REPORT_ERROR' | 'ENCOMPASS_ERROR' | 'ENRICH_ERROR' | 'FRAUD_INSIGHTS_ERROR' | 'FREDDIE_MAC_ERROR' | 'LINK_DELIVERY_ERROR' | 'PROFILE_ERROR' | 'RECURRING_TRANSACTIONS_ERROR' | 'STATEMENTS_ERROR' | 'TRANSFER_RECURRING_ERROR' | 'TRANSFER_REFUND_ERROR', required — A broad categorization of the error. Safe for programmatic use. - `error_code` string, required — The particular error code. Safe for programmatic use. - `error_code_reason` string, nullable — The specific reason for the error code. Currently, reasons are only supported for OAuth-based item errors; `null` will be returned otherwise. Safe for programmatic use. Possible values: `OAUTH_INVALID_TOKEN`: The user's OAuth connection to this institution has been invalidated. `OAUTH_CONSENT_EXPIRED`: The user's access consent for this OAuth connection to this institution has expired. `OAUTH_USER_REVOKED`: The user's OAuth connection to this institution is invalid because the user revoked their connection. - `error_message` string, required — A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use. - `display_message` string, nullable, required — A user-friendly representation of the error code. `null` if the error is not related to user action. This may change over time and is not safe for programmatic use. - `request_id` string — A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks. - `causes` unknown[] — In this product, a request can pertain to more than one Item. If an error is returned for such a request, `causes` will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified. `causes` will be provided for the `error_type` `ASSET_REPORT_ERROR` or `CHECK_REPORT_ERROR`. `causes` will also not be populated inside an error nested within a `warning` object. - unknown - `status` integer, nullable — The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook. - `documentation_url` string — The URL of a Plaid documentation page with more information about the error - `suggested_action` string, nullable — Suggested steps for resolving the error - `required_account_subtypes` string[] — A list of the account subtypes that were requested via the `account_filters` parameter in `/link/token/create`. Currently only populated for `NO_ACCOUNTS` errors from Items with `investments_auth` as an enabled product. - `provided_account_subtypes` string[] — A list of the account subtypes that were extracted but did not match the requested subtypes via the `account_filters` parameter in `/link/token/create`. Currently only populated for `NO_ACCOUNTS` errors from Items with `investments_auth` as an enabled product. - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. ## Other responses - `default` — Error response --- [API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/revisions/e536704a333f/schema)