{
  "opencollection": "1.0.0",
  "info": {
    "name": "Plaid income/",
    "version": "2020-09-14_1.517.0"
  },
  "items": [
    {
      "info": {
        "name": "Plaid",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Plaid (Deprecated) Create an income verification instance",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/income/verification/create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "`/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"
        },
        {
          "info": {
            "name": "Plaid (Deprecated) Retrieve information from the paystubs used for income verification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/income/verification/paystubs/get",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "`/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.\n\nThis endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instea"
        },
        {
          "info": {
            "name": "Plaid (Deprecated) Download the original documents used for income verification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/income/verification/documents/download",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "`/income/verification/documents/download` provides the ability to download the source documents associated with the verification.\n\nIf Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available\nfor download from the payroll provider will be available from this endpoint.\n\nThe response to `/income/verification/documents/download` is a ZIP file in binary data. If a `document_id` is passed, a single document will be contained i"
        },
        {
          "info": {
            "name": "Plaid (Deprecated) Retrieve information from the tax documents used for income verification",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/income/verification/taxforms/get",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "`/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.\n\nThis endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead."
        },
        {
          "info": {
            "name": "Plaid (Deprecated) Check digital income verification eligibility and optimize conversion",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/income/verification/precheck",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "`/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a `precheck_id` that can be provided to `/link/token/create`. If the user is eligible for digital verification, providing the `precheck_id` in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligib"
        },
        {
          "info": {
            "name": "Plaid Manually fire an Income webhook",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/sandbox/income/fire_webhook",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment."
        }
      ]
    }
  ],
  "bundled": true
}