Skip to main content
PUT
/
v2
/
organizations
/
{entityId}
/
relationships
Add or update relationships for an organization
curl --request PUT \
  --url https://api.uat.frankie.one/v2/organizations/{entityId}/relationships \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "entityRelationships": [
    {
      "entity": {
        "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "entityType": "INDIVIDUAL"
      },
      "relationships": [
        {
          "type": "OFFICIAL",
          "role": {
            "code": "DR",
            "description": "Director"
          }
        }
      ]
    }
  ]
}
'
{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "entityRelationships": [
    {
      "entity": {
        "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "entityType": "INDIVIDUAL"
      },
      "relationships": [
        {
          "type": "OFFICIAL",
          "role": {
            "code": "DR",
            "description": "Director"
          }
        }
      ]
    }
  ]
}

Authorizations

​
api_key
string
header
required

Headers

​
api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

​
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.

​
X-Frankie-Username
string

Username provided by API caller

Example:

"[email protected]"

Path Parameters

​
entityId
string
required

Unique FrankieOne identifier for an entity

Body

application/json

List of entities and their relationships with an organization

​
entityRelationships
object[]

List of entities and their relationships that should be added or updated, or have been requested, for an organization. These do not include or affect any relationships from for example ownership reports.

Response

OK

List of entities and their relationships with an organization

​
requestId
string
required

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
entityRelationships
object[]

List of entities and their relationships with an organization