Skip to main content
POST
/
tpa
/
account
/
create
Create TPA Account
curl --request POST \
  --url https://api.stax.ai/tpa/account/create \
  --header 'Content-Type: application/json' \
  --cookie authToken= \
  --data '
{
  "planId": "<string>",
  "accountType": "brokerage",
  "provider": "<string>",
  "number": "<string>",
  "payee": "<string>",
  "active": true,
  "internalPlanId": "<string>",
  "pensionProId": 123
}
'
{
  "success": true,
  "account": {
    "_id": "<string>",
    "team": "<string>",
    "planId": "<string>",
    "accountType": "<string>",
    "pensionProId": 123,
    "internalPlanId": "<string>",
    "provider": "<string>",
    "number": "<string>",
    "payee": "<string>",
    "active": true,
    "ppLock": true,
    "notes": [
      {
        "author": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "content": "<string>"
      }
    ],
    "lastModified": "2023-11-07T05:31:56Z",
    "type": "<string>",
    "status": {},
    "viewed": {}
  }
}

Authorizations

authToken
string
cookie
required

Cookie-based authentication using userId and authToken cookies

Body

application/json
planId
string
required

MongoDB ObjectId

accountType
string
default:brokerage
provider
string
number
string
payee
string
active
boolean
internalPlanId
string
pensionProId
number

Response

200 - application/json

Account created

success
boolean
account
object