Skip to main content
GET
/
business
/
{entityId}
/
parentAssociations
(AUS Only) Retrieve all the parent associations for an Individual or a Business
curl --request GET \
  --url https://api.uat.frankie.one/compliance/v1.2/business/{entityId}/parentAssociations \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'
{
  "parentAssociations": [
    {
      "associations": [
        {
          "association": "<string>",
          "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "roleDescriptions": [
            "<string>"
          ],
          "roles": [
            "<string>"
          ]
        }
      ],
      "entityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "requestId": "01BFJA617JMJXEW6G7TDDXNSHX"
}

Authorizations

​
api_key
string
header
required

API key issued by Frankie Financial. This will rotate regularly.

Headers

​
X-Frankie-CustomerID
string<uuid>
required

Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.

​
X-Frankie-CustomerChildID
string<uuid>

If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.

Note: If using a CustomerChildID, you will also need a separate api_key for each child.

Any documents, checks, entities that are created when this field has been populated will now be tied to this CustomerID + CustomerChildID combination. Just as Customers cannot see data created by other Customers, so too a Customer's Children will not be able to see each other's data.

A Customer can see the documents/entities and checks of all their Children.

​
X-Frankie-Channel
string

Open string that can be used to define the "channel" the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are:

  • api
  • portal
  • smartui

Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

Path Parameters

​
entityId
string<uuid>
required

The entityId returned previously from an earlier call to /check or /entity

Query Parameters

​
resultLevel
string

Depth to which we need to retrieve parent entities. Values could be "FULL" or an integer. This param is optional. Default depth is FULL.

Response

This is the payload for parent associations request. It contains all the parent associations for a given entity.

The result of an /business/{entityId}/parentAssociations call

​
parentAssociations
object[]

A list of all parent associations of entity

​
requestId
string<ulid>

Unique identifier for every request. Can be used for tracking down answers with technical support.

Uses the ULID format (a time-based, sortable UUID)

Note: this will be different for every request.

Example:

"01BFJA617JMJXEW6G7TDDXNSHX"