API Documentation
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 |
Name of the bank for this account. |
| accounts[].account_id |
int. |
| accounts[].account_name |
The account name, if provided by the bank. |
| accounts[].last_opt_in |
Timestamp of when this account was added (YYYYMMDD) |
| accounts[].account_type |
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”
- 401a
- 401k
- 403b
- 457plan
- 529plan
- annuity
- auto_loan
- certificate_of_deposit
- checking
- credit_card
- employee_stock_purchase_plan
- escrow
- investment
- investment_tax_deferred
- ira
- keogh
- line_of_credit
- loan
- money_market
- mortgage
- rollover
- roth
- savings
- student_loan
- ugma
- utma
- UNKNOWN
