Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.frankieone.com/llms.txt

Use this file to discover all available pages before exploring further.

The Retrieve Parent Associations Endpoint will allow fetching the parent associations of an entity either Business or Individual. Parent associations are where the entities are a part of the owners and officeholders either through the ASIC registry or manual association. These associations also include any associations created via the manually associated entities workflow. We can also assign the depth to which we would like to fetch the associations for example only the directly associated parent - 1 level etc.
Please note the associations will also include any deactivated entities that exist in the system as parents.

​
Endpoint

../../business/{entityId}/parentAssociations

​
Params

resultLevel - This determines to what level the results will be fetched in the query. The default is Full. You can assign numbers to the level you would like to retrieve association till.

​
Request

Request 
    curl --request GET \  
       --url 'https://api.demo.frankiefinancial.io/compliance/v1.2/business/{{entityId}}/parentAssociations?resultLevel=Full' \  
        --header 'Accept: application/json' \  
        --header 'X-Frankie-CustomerID: YOUR_CUSTOMER_ID' \  
        --header 'api_key: YOUR_API_KEY'

​
Response

Response
{
  "parentAssociations": [
    {
      "associations": [
        {
          "association": "ultimate_beneficial_owner",
          "parentId": "15b338c9-32a8-611d-86ac-ab8dff1c67db"
        },
        {
          "association": "shareholder",
          "parentId": "15b338c9-32a8-611d-86ac-ab8dff1c67db"
        }
      ],
      "entityId": "7d58f272-67da-0b3c-2ec5-fd318035e8e5"
    },
    {
      "associations": [
        {
          "association": "static_officer",
          "parentId": "a8ed972a-6ed2-e5dc-c6e0-d72a27565bfd",
          "roleDescriptions": ["Beneficiary"],
          "roles": ["BEN"]
        },
        {
          "association": "static_beneficial_owner",
          "parentId": "a8ed972a-6ed2-e5dc-c6e0-d72a27565bfd"
        }
      ],
      "entityId": "15b338c9-32a8-611d-86ac-ab8dff1c67db"
    }
  ],
  "requestId": "01G7XNQ072CP5QZD95NFWEHXXP"
}
The above response contains associations of 3 entities.
  • Entity 7d58f272-67da-0b3c-2ec5-fd318035e8e5 has two types of associations with the entity ID - 15b338c9-32a8-611d-86ac-ab8dff1c67db (which is it’s parent) which are as a shareholder and a ultimate_beneficial_owner
  • Entity 15b338c9-32a8-611d-86ac-ab8dff1c67db has then subsequent assocaitions with the entity ID - a8ed972a-6ed2-e5dc-c6e0-d72a27565bfd(which is it’s parent) as a static_beneficial_owner and a static_officer
  • Entity a8ed972a-6ed2-e5dc-c6e0-d72a27565bfd has no further parent associations
So based on the resultLevel provided in the request, the response will contain the parent associations for the primary entity and the parent associations of the entities identified at each level till it reaches a point where there are no further parent associations in the identified entities.