Entities

GET /portfolio/{fin}/entities

Entities

This endpoint returns a list of entities that the user has permission to view.

Path parameters

fin string Required

The Finplex Identity Number of the user

Query parameters

fen string | null

Optional Finplex Entity Number to receive information about a specific entity.

Responses

200

Ok
Hide response attributes Show response attributes array[object]
- activeState string Required
  
  Values are Active, Closed, Pending, or Suspended.
- company string Required
  
  The company the entity is associated with.
- contacts array[object] Required
  
  One of:
  ActiveEntityContact array[object] array-2 array[object]
  
  Hide attributes Show attributes
  
  beneficialOwner boolean Required
  
  contactForm string Required
  
  Values are Organisation or Person.
  
  contactMethods array[object] | null
  
  One of:
  array-1 array[object] | null array-2 array[object] | null array-3 array[object] | null array-4 array[object] | null array-5 array[object] | null array-6 array[object] | null array-7 array[object] | null array-8 array[object] | null array-9 array[object] | null array-10 array[object] | null array-11 array[object] | null array-12 array[object] | null array-13 array[object] | null array-14 array[object] | null array-15 array[object] | null array-16 array[object] | null array-17 array[object] | null array-18 array[object] | null
  
  Hide attributes Show attributes
  
  address object Required
  
  Hide address attributes Show address attributes object
  
  city string Required
  
  countryName string Required
  
  line1 string Required
  
  line2 string | null
  
  line3 string | null
  
  postcode string Required
  
  state string Required
  
  summary string Required
  
  contactType string Required Discriminator
  
  Value is array-2.
  
  Hide attributes Show attributes
  
  address object Required
  
  Hide address attributes Show address attributes object
  
  city string Required
  
  countryName string Required
  
  line1 string Required
  
  line2 string | null
  
  line3 string | null
  
  postcode string Required
  
  state string Required
  
  summary string Required
  
  contactType string Required Discriminator
  
  Value is array-3.
  
  Hide attributes Show attributes
  
  address object Required
  
  Hide address attributes Show address attributes object
  
  city string Required
  
  countryName string Required
  
  line1 string Required
  
  line2 string | null
  
  line3 string | null
  
  postcode string Required
  
  state string Required
  
  summary string Required
  
  contactType string Required Discriminator
  
  Value is array-4.
  
  organisationName string | null
  
  personBirthdate string(date) | null
  
  personFamilyName string | null
  
  personFirstName string | null
  
  personInits string | null
  
  personTitle string | null
  
  shortName string Required
  
  status string Required Discriminator
  
  Value is ActiveEntityContact.
- displayName string Required
- executiveName string Required
- fen string Required
- legalType string Required
  
  Values are Individual, Joint, Trust, SMSF, or Company.
- name string Required
  
  The name of the entity.
- statuses object Required
  
  Hide statuses attribute Show statuses attribute object
  
  Additional properties: string

GET /portfolio/{fin}/entities

curl \
 -X GET http://api.example.com/portfolio/{fin}/entities

Response examples (200)

[
  {
    "activeState": "Active",
    "company": "string",
    "contacts": [
      {
        "beneficialOwner": true,
        "contactForm": "Organisation",
        "contactMethods": [
          {
            "contactType": "array-1"
          }
        ],
        "organisationName": "string",
        "personBirthdate": "2023-05-04",
        "personFamilyName": "string",
        "personFirstName": "string",
        "personInits": "string",
        "personTitle": "string",
        "shortName": "string",
        "status": "ActiveEntityContact"
      }
    ],
    "displayName": "string",
    "executiveName": "string",
    "fen": "string",
    "legalType": "Individual",
    "name": "string",
    "statuses": {}
  }
]

Response examples (200)

[
  {
    "activeState": "Active",
    "company": "string",
    "contacts": [
      {
        "beneficialOwner": true,
        "contactForm": "Organisation",
        "contactMethods": [
          {
            "contactType": "array-1"
          }
        ],
        "organisationName": "string",
        "personBirthdate": "2025-05-04",
        "personFamilyName": "string",
        "personFirstName": "string",
        "personInits": "string",
        "personTitle": "string",
        "shortName": "string",
        "status": "ActiveEntityContact"
      }
    ],
    "displayName": "string",
    "executiveName": "string",
    "fen": "string",
    "legalType": "Individual",
    "name": "string",
    "statuses": {
      "Additional properties:": "string"
    }
  }
]

Entities

Path parameters

Query parameters

Responses

contacts array[object] Required