1. Home
  2. Docs
  3. Data Subscriber API Documentation
  4. Endpoints Reference
  5. GET /persons/:id/accounts

GET /persons/:id/accounts

List all Accounts objects for any individual Person.

 

Headers

Name Value
Authorization Bearer {token}

URL parameters

Name Value
id int. The ID of a consumer (person) you added via POST /persons.

Response

Name Value
accounts List of JSON objects.
accounts[].bank string. Name of the bank for this account.
accounts[].account_id int.
accounts[].account_name string. The account name, if provided by the bank.
accounts[].last_opt_in string. Timestamp of when this account was added (YYYMMDD)
accounts[].account_type string. The type of this account (e.g., “checking”). The possible values are at the bottom of this page. NULL values are valid too.

Status Code

Code Comment
200 Request OK.
401 User not authorized

 

Valid values for “account_type”

All values are UTF-8 encoded strings.

  • 401a
  • 401k
  • 403b
  • 457plan
  • 529plan
  • certificate_of_deposit
  • checking
  • credit_card
  • employee_stock_purchase_plan
  • investment
  • investment_tax_deferred
  • ira
  • keogh
  • line_of_credit
  • loan
  • money_market
  • mortgage
  • rollover
  • roth
  • savings
  • student_loan
  • ugma
  • utma
  • UNKNOWN

How can we help?