lib/plaid/api/plaid_api.rb
# Retrieve identity data
# The &#x60;/identity/get&#x60; endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution.  Note: This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
# @param identity_get_request [IdentityGetRequest] 
# @param [Hash] opts the optional parameters
# @return [Array<(IdentityGetResponse, Integer, Hash)>] IdentityGetResponse data, response status code and response headers
Retrieve identity data
The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution.  Note: This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
Retrieve identity data The ` / identity / get ` endpoint allows you to retrieve various account holder information on file with the financial institution including names emails phone numbers and addresses . Only name data is guaranteed to be returned ; other fields will be empty arrays if not provided by the institution . Note : This request may take some time to complete if identity was not specified as an initial product when creating the Item . This is because Plaid must communicate directly with the institution to retrieve the data .
def identity_get_with_http_info(identity_get_request, opts = {})
      if @api_client.config.debugging
        @api_client.config.logger.debug 'Calling API: PlaidApi.identity_get ...'
      end
      if @api_client.config.client_side_validation && identity_get_request.nil?
        fail ArgumentError, "Missing the required parameter 'identity_get_request' when calling PlaidApi.identity_get"
      end
      local_var_path = '/identity/get'
      query_params = opts[:query_params] || {}
      header_params = opts[:header_params] || {}
      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
      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(identity_get_request)
      return_type = opts[:debug_return_type] || 'IdentityGetResponse'
      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
      new_options = opts.merge(
        :operation => :"PlaidApi.identity_get",
        :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#identity_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
      end
      return data, status_code, headers
    end
def identity_get_with_http_info ( identity_get_request , opts = { } ) if @api_client . config . debugging @api_client . config . logger . debug 'Calling API: PlaidApi.identity_get ...' end if @api_client . config . client_side_validation && identity_get_request . nil? fail ArgumentError , "Missing the required parameter 'identity_get_request' when calling PlaidApi.identity_get" end local_var_path = '/identity/get' query_params = opts [ :query_params ] || { } header_params = opts [ :header_params ] || { } header_params [ 'Accept' ] = @api_client . select_header_accept ( [ 'application/json' ] ) 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 ( identity_get_request ) return_type = opts [ :debug_return_type ] || 'IdentityGetResponse' auth_names = opts [ :debug_auth_names ] || [ 'clientId' , 'plaidVersion' , 'secret' ] new_options = opts . merge ( :operation => :" PlaidApi.identity_get " , :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#identity_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data , status_code , headers end
Retrieve identity data
The &#x60;/identity/get&#x60; endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.
Retrieve identity data The &#x60 ; / identity / get&#x60 ; endpoint allows you to retrieve various account holder information on file with the financial institution including names emails phone numbers and addresses .
# verify the required parameter 'identity_get_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
IdentityGetResponse data, response status code and response headers
IdentityGetResponse data response status code and response headers
Array<(IdentityGetResponse, Integer, Hash)>
identity_get_request
opts
None
opts the optional parameters
opts the optional parameters