lib/plaid/api/plaid_api.rb
def income_verification_documents_download_with_http_info(income_verification_documents_download_request, opts = {})
      if @api_client.config.debugging
        @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_documents_download ...'
      end
      # verify the required parameter 'income_verification_documents_download_request' is set
      if @api_client.config.client_side_validation && income_verification_documents_download_request.nil?
        fail ArgumentError, "Missing the required parameter 'income_verification_documents_download_request' when calling PlaidApi.income_verification_documents_download"
      end
      # resource path
      local_var_path = '/income/verification/documents/download'

      # query parameters
      query_params = opts[:query_params] || {}

      # header parameters
      header_params = opts[:header_params] || {}
      # HTTP header 'Accept' (if needed)
      header_params['Accept'] = @api_client.select_header_accept(['application/zip'])
      # HTTP header 'Content-Type'
      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

      # form parameters
      form_params = opts[:form_params] || {}

      # http body (model)
      post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_documents_download_request)

      # return_type
      return_type = opts[:debug_return_type] || 'File'

      # auth_names
      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

      new_options = opts.merge(
        :operation => :"PlaidApi.income_verification_documents_download",
        :header_params => header_params,
        :query_params => query_params,
        :form_params => form_params,
        :body => post_body,
        :auth_names => auth_names,
        :return_type => return_type
      )

      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
      if @api_client.config.debugging
        @api_client.config.logger.debug "API called: PlaidApi#income_verification_documents_download\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
      end
      return data, status_code, headers
    end
# Download the original documents used for income verification
# &#x60;/income/verification/documents/download&#x60; provides the ability to download the source documents associated with the verification.  If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint.  The response to &#x60;/income/verification/documents/download&#x60; is ZIP file in binary data. If a document_id is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification.  The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header.
# @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest] 
# @param [Hash] opts the optional parameters
# @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
Download the original documents used for income verification
`/income/verification/documents/download` provides the ability to download the source documents associated with the verification.  If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint.  The response to `/income/verification/documents/download` is ZIP file in binary data. If a document_id is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification.  The `request_id` is returned in the `Plaid-Request-ID` header.
Download the original documents used for income verification ` / income / verification / documents / download ` provides the ability to download the source documents associated with the verification . If Document Income was used the documents will be those the user provided in Link . For Payroll Income the most recent files available for download from the payroll provider will be available from this endpoint . The response to ` / income / verification / documents / download ` is ZIP file in binary data . If a document_id is passed a single document will be contained in this file . If not the response will contain all documents associated with the verification . The ` request_id ` is returned in the ` Plaid - Request - ID ` header .
def income_verification_documents_download_with_http_info(income_verification_documents_download_request, opts = {})
      if @api_client.config.debugging
        @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_documents_download ...'
      end
      if @api_client.config.client_side_validation && income_verification_documents_download_request.nil?
        fail ArgumentError, "Missing the required parameter 'income_verification_documents_download_request' when calling PlaidApi.income_verification_documents_download"
      end
      local_var_path = '/income/verification/documents/download'
      query_params = opts[:query_params] || {}
      header_params = opts[:header_params] || {}
      header_params['Accept'] = @api_client.select_header_accept(['application/zip'])
      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
      form_params = opts[:form_params] || {}
      post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_documents_download_request)
      return_type = opts[:debug_return_type] || 'File'
      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
      new_options = opts.merge(
        :operation => :"PlaidApi.income_verification_documents_download",
        :header_params => header_params,
        :query_params => query_params,
        :form_params => form_params,
        :body => post_body,
        :auth_names => auth_names,
        :return_type => return_type
      )
      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
      if @api_client.config.debugging
        @api_client.config.logger.debug "API called: PlaidApi#income_verification_documents_download\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
      end
      return data, status_code, headers
    end
def income_verification_documents_download_with_http_info ( income_verification_documents_download_request , opts = { } ) if @api_client . config . debugging @api_client . config . logger . debug 'Calling API: PlaidApi.income_verification_documents_download ...' end if @api_client . config . client_side_validation && income_verification_documents_download_request . nil? fail ArgumentError , "Missing the required parameter 'income_verification_documents_download_request' when calling PlaidApi.income_verification_documents_download" end local_var_path = '/income/verification/documents/download' query_params = opts [ :query_params ] || { } header_params = opts [ :header_params ] || { } header_params [ 'Accept' ] = @api_client . select_header_accept ( [ 'application/zip' ] ) header_params [ 'Content-Type' ] = @api_client . select_header_content_type ( [ 'application/json' ] ) form_params = opts [ :form_params ] || { } post_body = opts [ :debug_body ] || @api_client . object_to_http_body ( income_verification_documents_download_request ) return_type = opts [ :debug_return_type ] || 'File' auth_names = opts [ :debug_auth_names ] || [ 'clientId' , 'plaidVersion' , 'secret' ] new_options = opts . merge ( :operation => :" PlaidApi.income_verification_documents_download " , :header_params => header_params , :query_params => query_params , :form_params => form_params , :body => post_body , :auth_names => auth_names , :return_type => return_type ) data , status_code , headers = @api_client . call_api ( :POST , local_var_path , new_options ) if @api_client . config . debugging @api_client . config . logger . debug "API called: PlaidApi#income_verification_documents_download\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data , status_code , headers end
Download the original documents used for income verification
&#x60;/income/verification/documents/download&#x60; provides the ability to download the source documents associated with the verification.
Download the original documents used for income verification &#x60 ; / income / verification / documents / download&#x60 ; provides the ability to download the source documents associated with the verification .
# verify the required parameter 'income_verification_documents_download_request' is set # resource path # query parameters # header parameters # HTTP header 'Accept' (if needed) # HTTP header 'Content-Type' # form parameters # http body (model) # return_type # auth_names
File data, response status code and response headers
File data response status code and response headers
Array<(File, Integer, Hash)>
income_verification_documents_download_request
opts
None
opts the optional parameters
opts the optional parameters