Sha256: 9f5f12208101c353c70b33bf1554c6338ca687af78c9cbc70e95f635f601cd85

Contents?: true

Size: 925 Bytes

Versions: 22

Compression:

Stored size: 925 Bytes

Contents

module Plaid
  # Public: Class used to call the Identity product.
  class Identity < BaseProduct
    # Public: Get Identity information.
    #
    # Does a POST /identity/get call to retrieve all info for a given
    # access_token's item.
    #
    # access_token - access_token who's item to fetch Identity data for.
    #
    # Returns the IdentityResponse object with Identity info.
    def get(access_token)
      post_with_auth 'identity/get',
                     IdentityResponse,
                     access_token: access_token
    end
  end

  # Public: Response for /identity/get.
  class IdentityResponse < Models::BaseResponse
    ##
    # :attr_reader:
    # Public: The list of accounts: Array of Plaid::Models::Account.
    property :accounts, coerce: Array[Models::AccountWithOwners]

    ##
    # :attr_reader:
    # Public: The item: Plaid::Models::Item.
    property :item, coerce: Models::Item
  end
end

Version data entries

22 entries across 22 versions & 1 rubygems

Version Path
plaid-11.1.1 lib/plaid/products/identity.rb
plaid-13.2.0 lib/plaid/products/identity.rb
plaid-13.1.0 lib/plaid/products/identity.rb
plaid-13.0.1 lib/plaid/products/identity.rb
plaid-13.0.0 lib/plaid/products/identity.rb
plaid-12.0.0 lib/plaid/products/identity.rb
plaid-11.1.0 lib/plaid/products/identity.rb
plaid-11.0.0 lib/plaid/products/identity.rb
plaid-10.1.0 lib/plaid/products/identity.rb
plaid-10.0.0 lib/plaid/products/identity.rb
plaid-9.0.0 lib/plaid/products/identity.rb
plaid-8.9.0 lib/plaid/products/identity.rb
plaid-8.8.0 lib/plaid/products/identity.rb
plaid-8.7.0 lib/plaid/products/identity.rb
plaid-8.6.0 lib/plaid/products/identity.rb
plaid-8.5.0 lib/plaid/products/identity.rb
plaid-8.4.0 lib/plaid/products/identity.rb
plaid-8.3.0 lib/plaid/products/identity.rb
plaid-8.2.0 lib/plaid/products/identity.rb
plaid-8.1.0 lib/plaid/products/identity.rb