Account Endpoints
Get account status
Get the status of a retirement account by account ID. The account status can be one of the following:
A
: Abandoned - The account has been abandoned.N
: New - The account is not yet open.O
: Open - The account is currently open.C
: Closed - The account has been closed.P
: Pending - The account is not yet open and is pending approval.R
: Rejected - The account has been rejected and is not open.
GET
/
accounts
/
account_status
/
{account_id}
Header
Path
curl --request GET \
--url https://sandbox.featherhq.com/accounts/account_status/{account_id} \
--header 'x-api-key: <x-api-key>'
{
"account_id": "<string>",
"account_state": "IncompleteApplication",
"account_status": "A"
}
Headers
x-api-key
string
requiredAPI Key for authentication
Path Parameters
account_id
string
requiredUnique identifier for the account
Response
200 - application/json
account_id
string
requiredUnique identifier for the account
account_state
enum<string>
Additional account state information (e.g., Incomplete Application, Under Review)
Available options:
IncompleteApplication
, DocumentsRequired
, UnderReview
, PendingApproval
account_status
enum<string>
requiredEnum representing the status of retirement accounts (e.g., IRA).
Available options:
A
, N
, O
, C
, P
, R
curl --request GET \
--url https://sandbox.featherhq.com/accounts/account_status/{account_id} \
--header 'x-api-key: <x-api-key>'
{
"account_id": "<string>",
"account_state": "IncompleteApplication",
"account_status": "A"
}