plaid

(Deprecated) Create an income verification instance

Changed on

/income/verification/create begins the income verification process by returning an income_verification_id. You can then provide the income_verification_id to /link/token/create under the income_verification parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an INCOME webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.

post/income/verification/create

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/income/verification/create
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

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.

webhookstring required

The URL endpoint to which Plaid should send webhooks related to the progress of the income verification process.

precheck_idstring

The ID of a precheck created with /income/verification/precheck. Will be used to improve conversion of the income verification flow.

Response

OK

income_verification_idstring required

ID of the verification. This ID is persisted throughout the lifetime of the verification.

request_idstring required

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

Changes

  • ea443cd78f6fRevision changes
    • warning

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

    • warning

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

  • a1bbca018160Revision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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