Accounts

The Accounts API allows you to create and manage accounts. Use this API to create new accounts, update account information, and manage account status.

API Endpoints Overview

The Accounts API provides endpoints for managing accounts and portfolios. Below is a complete list of available endpoints organized by functional area.

Account Management

Endpoint	Method	Description
`/v1/accounts`	POST	Create a new account
`/v1/accounts/:accountId`	GET	Get account details
`/v1/accounts/:accountId`	PUT	Update account information
`/v1/accounts/:accountId/freeze`	PUT	Freeze an account

Create an Account

Create a new account.

Request Body Parameters

Parameter	Type	Description	Required
`accountId`	String	Unique ID for the account (UUID v4)	Yes
`accountType`	String	Account type: INDIVIDUAL, IRA, or ROTH_IRA	Yes
`portfolioType`	String	Portfolio type: CASH or MARGIN	Yes
`firstName`	String	Account holder first name	No
`lastName`	String	Account holder last name	No

Request

POST

/v1/accounts

curl -X POST https://api.paperinvest.io/v1/accounts \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "550e8400-e29b-41d4-a716-446655440000",
    "accountType": "INDIVIDUAL",
    "portfolioType": "MARGIN",
    "firstName": "John",
    "lastName": "Doe"
  }'

Response

201 Created

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "accountType": "INDIVIDUAL",
  "portfolioType": "MARGIN",
  "firstName": "John",
  "lastName": "Doe",
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-01T12:00:00Z"
}

Get Account

Retrieve details for a specific account.

Path Parameters

Parameter	Type	Description	Required
`accountId`	String	The account ID (UUID)	Yes

Request

GET

/v1/accounts/:accountId

curl -X GET https://api.paperinvest.io/v1/accounts/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Response

200 OK

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "accountType": "INDIVIDUAL",
  "portfolioType": "MARGIN",
  "firstName": "John",
  "lastName": "Doe",
  "stripeCustomerId": "cus_123456789",
  "subscriptionStatus": "active",
  "subscriptionTier": "premium",
  "createdAt": "2025-01-01T12:00:00Z",
  "updatedAt": "2025-01-01T12:00:00Z"
}