Sign in
plaid

(Deprecated) Retrieve information from the tax documents used for income verification

/income/verification/taxforms/get returns the information collected from forms 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.

post/income/verification/taxforms/get

Request body

client_idstring

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.

secretstring

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_idstring nullable

The ID of the verification.

access_tokenstring nullable

The access token associated with the Item for which data is being requested.

Response

OK

request_idstring

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

Changed in 10 of the 53 revisions of this API.5730

  • a1bbca01816027See the full diff
    • ●

      added the new ASSETS_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new ASSETS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new CRA_MONITORING_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new CRA_MONITORING_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new CREDIT_PROFILE_REPORT_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new CREDIT_PROFILE_REPORT_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new DOCUMENT_TYPE_US_STUDENT_I20 enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new ENCOMPASS_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new ENCOMPASS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new ENRICH_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new ENRICH_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new FRAUD_INSIGHTS_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new FRAUD_INSIGHTS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new FREDDIE_MAC_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new FREDDIE_MAC_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new LINK_DELIVERY_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new LINK_DELIVERY_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new PROFILE_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new PROFILE_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new RECURRING_TRANSACTIONS_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new RECURRING_TRANSACTIONS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new STATEMENTS_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new STATEMENTS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new TRANSFER_RECURRING_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new TRANSFER_RECURRING_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new TRANSFER_REFUND_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new TRANSFER_REFUND_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 80d23bfdc2e52See the full diff
    • ●

      added the new IDEMPOTENCY_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDEMPOTENCY_ERROR enum value to the response property for the response status

      response-property-enum-value-added

  • fb8c3f188d8b2See the full diff
    • ●

      added the new BASE_REPORT_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new BASE_REPORT_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 465584b48c994See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4abee1c569292See the full diff
    • ○

      removed the IDENTITY_ERROR enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the IDENTITY_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

  • f8b9f1a857674See the full diff
    • ●

      added the new IDENTITY_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new IDENTITY_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new USER_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new USER_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • af4b6e71d87f2See the full diff
    • ●

      added the new SIGNAL_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new SIGNAL_ERROR enum value to the response property for the response status

      response-property-enum-value-added

  • 09cbc84449134See the full diff
    • ●

      added the new CHECK_REPORT_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new CHECK_REPORT_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new CONSUMER_REPORT_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new CONSUMER_REPORT_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a2c34406c317102See the full diff
    • ●

      added the new PARTNER_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new PARTNER_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new SANDBOX_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new SANDBOX_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new TRANSACTIONS_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new TRANSACTIONS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new TRANSACTION_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new TRANSACTION_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new TRANSFER_ERROR enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new TRANSFER_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5de70cc1e6ca622See the full diff
    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      removed the BASE_REPORT_ERROR enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the BASE_REPORT_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CHECK_REPORT_ERROR enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CHECK_REPORT_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CONSUMER_REPORT_ERROR enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the CONSUMER_REPORT_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the IDEMPOTENCY_ERROR enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the IDEMPOTENCY_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PARTNER_ERROR enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the PARTNER_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SANDBOX_ERROR enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SANDBOX_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SIGNAL_ERROR enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the SIGNAL_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TRANSACTIONS_ERROR enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TRANSACTIONS_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TRANSACTION_ERROR enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TRANSACTION_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TRANSFER_ERROR enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the TRANSFER_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the USER_ERROR enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed the USER_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    This revision also has 699 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog