Create Entity

POST /portfolio/{fin}/entities

Create Entity

Create a new entity for a user

Path parameters

fin string Required

The Finplex Identity Number of the user to create the entity under

application/json

Body Required

appId string Required
displayName string | null
legalName string Required
legalType string Required

Values are Individual, Joint, Trust, SMSF, or Company.

Responses

201

Created

POST /portfolio/{fin}/entities

curl \
 -X POST http://api.example.com/portfolio/{fin}/entities \
 -H "Content-Type: application/json" \
 -d '{"appId":"string","displayName":"string","legalName":"string","legalType":"Individual"}'

Request example

{
  "appId": "string",
  "displayName": "string",
  "legalName": "string",
  "legalType": "Individual"
}

Request examples

{
  "appId": "string",
  "displayName": "string",
  "legalName": "string",
  "legalType": "Individual"
}

Response examples (201)

"string"

Response examples (201)

string